Updated docs
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>.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:/home/jcgregorio/projects/apiclient/apiclient/contrib/__init__.py">/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:/home/jcgregorio/projects/apiclient/apiclient/contrib/latitude/__init__.py">/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:/home/jcgregorio/projects/apiclient/apiclient/contrib/moderator/__init__.py">/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:/home/jcgregorio/projects/apiclient/apiclient/discovery.py">/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>
|
||||
|
||||
@@ -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:/home/jcgregorio/projects/apiclient/apiclient/errors.py">/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>
|
||||
|
||||
@@ -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>.appengine</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient-release/apiclient/ext/appengine.py">/usr/local/google/home/jcgregorio/projects/apiclient-release/apiclient/ext/appengine.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient/apiclient/ext/appengine.py">/home/jcgregorio/projects/apiclient/apiclient/ext/appengine.py</a></font></td></tr></table>
|
||||
<p><tt>Utilities for Google App Engine<br>
|
||||
<br>
|
||||
Utilities for making it easier to use the<br>
|
||||
@@ -116,6 +116,20 @@ the arguments to this class and what they&nbs
|
||||
Returns:<br>
|
||||
Default value as provided by <a href="#FlowThreeLeggedProperty-__init__">__init__</a>(default).</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedProperty-get_updated_value_for_datastore"><strong>get_updated_value_for_datastore</strong></a>(self, model_instance)</dt><dd><tt>Determine new value for auto-updated property.<br>
|
||||
<br>
|
||||
Some properies (e.g. DateTimeProperty, UserProperty) optionally update their<br>
|
||||
value on every put(). This call must return the new desired value for such<br>
|
||||
properties. For all other properties, this call must return<br>
|
||||
AUTO_UPDATE_UNCHANGED.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
model_instance: Instance to get new value for.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
Datastore representation of the new model value in a form that is<br>
|
||||
appropriate for storing in the datastore, or AUTO_UPDATE_UNCHANGED.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
@@ -200,6 +214,20 @@ the arguments to this class and what they&nbs
|
||||
Returns:<br>
|
||||
Default value as provided by <a href="#OAuthCredentialsProperty-__init__">__init__</a>(default).</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsProperty-get_updated_value_for_datastore"><strong>get_updated_value_for_datastore</strong></a>(self, model_instance)</dt><dd><tt>Determine new value for auto-updated property.<br>
|
||||
<br>
|
||||
Some properies (e.g. DateTimeProperty, UserProperty) optionally update their<br>
|
||||
value on every put(). This call must return the new desired value for such<br>
|
||||
properties. For all other properties, this call must return<br>
|
||||
AUTO_UPDATE_UNCHANGED.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
model_instance: Instance to get new value for.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
Datastore representation of the new model value in a form that is<br>
|
||||
appropriate for storing in the datastore, or AUTO_UPDATE_UNCHANGED.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</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:/home/jcgregorio/projects/apiclient/apiclient/ext/authtools.py">/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>
|
||||
|
||||
@@ -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>.django_orm</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient-release/apiclient/ext/django_orm.py">/usr/local/google/home/jcgregorio/projects/apiclient-release/apiclient/ext/django_orm.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient/apiclient/ext/django_orm.py">/home/jcgregorio/projects/apiclient/apiclient/ext/django_orm.py</a></font></td></tr></table>
|
||||
<p><tt># Copyright (C) 2010 Google Inc.<br>
|
||||
#<br>
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");<br>
|
||||
@@ -65,13 +65,9 @@
|
||||
Methods defined here:<br>
|
||||
<dl><dt><a name="FlowThreeLeggedField-contribute_to_class"><strong>contribute_to_class</strong></a>(self, cls, name)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-db_type"><strong>db_type</strong></a> = inner(*args, **kwargs)</dt></dl>
|
||||
<dl><dt><a name="FlowThreeLeggedField-db_type"><strong>db_type</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-get_db_prep_lookup"><strong>get_db_prep_lookup</strong></a> = inner(*args, **kwargs)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-get_db_prep_save"><strong>get_db_prep_save</strong></a> = inner(*args, **kwargs)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-get_db_prep_value"><strong>get_db_prep_value</strong></a> = inner(*args, **kwargs)</dt></dl>
|
||||
<dl><dt><a name="FlowThreeLeggedField-get_db_prep_value"><strong>get_db_prep_value</strong></a>(self, value)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-to_python"><strong>to_python</strong></a>(self, value)</dt></dl>
|
||||
|
||||
@@ -86,14 +82,10 @@ Methods inherited from <a href="django.db.models.fields.html#Field">django.db.mo
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-__deepcopy__"><strong>__deepcopy__</strong></a>(self, memodict)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-__init__"><strong>__init__</strong></a>(self, verbose_name<font color="#909090">=None</font>, name<font color="#909090">=None</font>, primary_key<font color="#909090">=False</font>, max_length<font color="#909090">=None</font>, unique<font color="#909090">=False</font>, blank<font color="#909090">=False</font>, null<font color="#909090">=False</font>, db_index<font color="#909090">=False</font>, rel<font color="#909090">=None</font>, default<font color="#909090">=<class django.db.models.fields.NOT_PROVIDED></font>, editable<font color="#909090">=True</font>, serialize<font color="#909090">=True</font>, unique_for_date<font color="#909090">=None</font>, unique_for_month<font color="#909090">=None</font>, unique_for_year<font color="#909090">=None</font>, choices<font color="#909090">=None</font>, help_text<font color="#909090">=''</font>, db_column<font color="#909090">=None</font>, db_tablespace<font color="#909090">=None</font>, auto_created<font color="#909090">=False</font>, validators<font color="#909090">=[]</font>, error_messages<font color="#909090">=None</font>)</dt></dl>
|
||||
<dl><dt><a name="FlowThreeLeggedField-__init__"><strong>__init__</strong></a>(self, verbose_name<font color="#909090">=None</font>, name<font color="#909090">=None</font>, primary_key<font color="#909090">=False</font>, max_length<font color="#909090">=None</font>, unique<font color="#909090">=False</font>, blank<font color="#909090">=False</font>, null<font color="#909090">=False</font>, db_index<font color="#909090">=False</font>, rel<font color="#909090">=None</font>, default<font color="#909090">=<class django.db.models.fields.NOT_PROVIDED></font>, editable<font color="#909090">=True</font>, serialize<font color="#909090">=True</font>, unique_for_date<font color="#909090">=None</font>, unique_for_month<font color="#909090">=None</font>, unique_for_year<font color="#909090">=None</font>, choices<font color="#909090">=None</font>, help_text<font color="#909090">=''</font>, db_column<font color="#909090">=None</font>, db_tablespace<font color="#909090">=None</font>, auto_created<font color="#909090">=False</font>)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-bind"><strong>bind</strong></a>(self, fieldmapping, original, bound_field_class)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-clean"><strong>clean</strong></a>(self, value, model_instance)</dt><dd><tt>Convert the value's type and run validation. Validation errors from to_python<br>
|
||||
and validate are propagated. The correct value is returned if no error is<br>
|
||||
raised.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-formfield"><strong>formfield</strong></a>(self, form_class<font color="#909090">=<class 'django.forms.fields.CharField'></font>, **kwargs)</dt><dd><tt>Returns a django.forms.<a href="django.db.models.fields.html#Field">Field</a> instance for this database <a href="django.db.models.fields.html#Field">Field</a>.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-get_attname"><strong>get_attname</strong></a>(self)</dt></dl>
|
||||
@@ -107,31 +99,26 @@ as SelectField choices for this field.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-get_choices_default"><strong>get_choices_default</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-get_db_prep_lookup"><strong>get_db_prep_lookup</strong></a>(self, lookup_type, value)</dt><dd><tt>Returns field's value prepared for database lookup.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-get_db_prep_save"><strong>get_db_prep_save</strong></a>(self, value)</dt><dd><tt>Returns field's value prepared for saving into a database.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-get_default"><strong>get_default</strong></a>(self)</dt><dd><tt>Returns the default value for this field.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-get_flatchoices"><strong>get_flatchoices</strong></a>(self, include_blank<font color="#909090">=True</font>, blank_choice<font color="#909090">=[('', '---------')]</font>)</dt><dd><tt>Returns flattened choices with a default blank choice included.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-get_internal_type"><strong>get_internal_type</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-get_prep_lookup"><strong>get_prep_lookup</strong></a>(self, lookup_type, value)</dt><dd><tt>Perform preliminary non-db specific lookup checks and conversions</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-get_prep_value"><strong>get_prep_value</strong></a>(self, value)</dt><dd><tt>Perform preliminary non-db specific value checks and conversions.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-get_validator_unique_lookup_type"><strong>get_validator_unique_lookup_type</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-has_default"><strong>has_default</strong></a>(self)</dt><dd><tt>Returns a boolean of whether this field has a default value.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-pre_save"><strong>pre_save</strong></a>(self, model_instance, add)</dt><dd><tt>Returns field's value just before saving.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-run_validators"><strong>run_validators</strong></a>(self, value)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-save_form_data"><strong>save_form_data</strong></a>(self, instance, data)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-set_attributes_from_name"><strong>set_attributes_from_name</strong></a>(self, name)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-validate"><strong>validate</strong></a>(self, value, model_instance)</dt><dd><tt>Validates value and throws ValidationError. Subclasses should override<br>
|
||||
this to provide validation logic.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-value_from_object"><strong>value_from_object</strong></a>(self, obj)</dt><dd><tt>Returns the value of this field in the given model instance.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowThreeLeggedField-value_to_string"><strong>value_to_string</strong></a>(self, obj)</dt><dd><tt>Returns a string value of this field from the passed obj.<br>
|
||||
@@ -147,8 +134,6 @@ Data descriptors inherited from <a href="django.db.models.fields.html#Field">dja
|
||||
</dl>
|
||||
<dl><dt><strong>choices</strong></dt>
|
||||
</dl>
|
||||
<dl><dt><strong>description</strong></dt>
|
||||
</dl>
|
||||
<dl><dt><strong>flatchoices</strong></dt>
|
||||
<dd><tt>Flattened version of choices tuple.</tt></dd>
|
||||
</dl>
|
||||
@@ -160,10 +145,6 @@ Data and other attributes inherited from <a href="django.db.models.fields.html#F
|
||||
|
||||
<dl><dt><strong>creation_counter</strong> = 0</dl>
|
||||
|
||||
<dl><dt><strong>default_error_messages</strong> = {'blank': <django.utils.functional.__proxy__ object>, 'invalid_choice': <django.utils.functional.__proxy__ object>, 'null': <django.utils.functional.__proxy__ object>}</dl>
|
||||
|
||||
<dl><dt><strong>default_validators</strong> = []</dl>
|
||||
|
||||
<dl><dt><strong>empty_strings_allowed</strong> = True</dl>
|
||||
|
||||
</td></tr></table> <p>
|
||||
@@ -182,13 +163,9 @@ Data and other attributes inherited from <a href="django.db.models.fields.html#F
|
||||
Methods defined here:<br>
|
||||
<dl><dt><a name="OAuthCredentialsField-contribute_to_class"><strong>contribute_to_class</strong></a>(self, cls, name)</dt></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-db_type"><strong>db_type</strong></a> = inner(*args, **kwargs)</dt></dl>
|
||||
<dl><dt><a name="OAuthCredentialsField-db_type"><strong>db_type</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-get_db_prep_lookup"><strong>get_db_prep_lookup</strong></a> = inner(*args, **kwargs)</dt></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-get_db_prep_save"><strong>get_db_prep_save</strong></a> = inner(*args, **kwargs)</dt></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-get_db_prep_value"><strong>get_db_prep_value</strong></a> = inner(*args, **kwargs)</dt></dl>
|
||||
<dl><dt><a name="OAuthCredentialsField-get_db_prep_value"><strong>get_db_prep_value</strong></a>(self, value)</dt></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-to_python"><strong>to_python</strong></a>(self, value)</dt></dl>
|
||||
|
||||
@@ -203,14 +180,10 @@ Methods inherited from <a href="django.db.models.fields.html#Field">django.db.mo
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-__deepcopy__"><strong>__deepcopy__</strong></a>(self, memodict)</dt></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-__init__"><strong>__init__</strong></a>(self, verbose_name<font color="#909090">=None</font>, name<font color="#909090">=None</font>, primary_key<font color="#909090">=False</font>, max_length<font color="#909090">=None</font>, unique<font color="#909090">=False</font>, blank<font color="#909090">=False</font>, null<font color="#909090">=False</font>, db_index<font color="#909090">=False</font>, rel<font color="#909090">=None</font>, default<font color="#909090">=<class django.db.models.fields.NOT_PROVIDED></font>, editable<font color="#909090">=True</font>, serialize<font color="#909090">=True</font>, unique_for_date<font color="#909090">=None</font>, unique_for_month<font color="#909090">=None</font>, unique_for_year<font color="#909090">=None</font>, choices<font color="#909090">=None</font>, help_text<font color="#909090">=''</font>, db_column<font color="#909090">=None</font>, db_tablespace<font color="#909090">=None</font>, auto_created<font color="#909090">=False</font>, validators<font color="#909090">=[]</font>, error_messages<font color="#909090">=None</font>)</dt></dl>
|
||||
<dl><dt><a name="OAuthCredentialsField-__init__"><strong>__init__</strong></a>(self, verbose_name<font color="#909090">=None</font>, name<font color="#909090">=None</font>, primary_key<font color="#909090">=False</font>, max_length<font color="#909090">=None</font>, unique<font color="#909090">=False</font>, blank<font color="#909090">=False</font>, null<font color="#909090">=False</font>, db_index<font color="#909090">=False</font>, rel<font color="#909090">=None</font>, default<font color="#909090">=<class django.db.models.fields.NOT_PROVIDED></font>, editable<font color="#909090">=True</font>, serialize<font color="#909090">=True</font>, unique_for_date<font color="#909090">=None</font>, unique_for_month<font color="#909090">=None</font>, unique_for_year<font color="#909090">=None</font>, choices<font color="#909090">=None</font>, help_text<font color="#909090">=''</font>, db_column<font color="#909090">=None</font>, db_tablespace<font color="#909090">=None</font>, auto_created<font color="#909090">=False</font>)</dt></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-bind"><strong>bind</strong></a>(self, fieldmapping, original, bound_field_class)</dt></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-clean"><strong>clean</strong></a>(self, value, model_instance)</dt><dd><tt>Convert the value's type and run validation. Validation errors from to_python<br>
|
||||
and validate are propagated. The correct value is returned if no error is<br>
|
||||
raised.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-formfield"><strong>formfield</strong></a>(self, form_class<font color="#909090">=<class 'django.forms.fields.CharField'></font>, **kwargs)</dt><dd><tt>Returns a django.forms.<a href="django.db.models.fields.html#Field">Field</a> instance for this database <a href="django.db.models.fields.html#Field">Field</a>.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-get_attname"><strong>get_attname</strong></a>(self)</dt></dl>
|
||||
@@ -224,31 +197,26 @@ as SelectField choices for this field.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-get_choices_default"><strong>get_choices_default</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-get_db_prep_lookup"><strong>get_db_prep_lookup</strong></a>(self, lookup_type, value)</dt><dd><tt>Returns field's value prepared for database lookup.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-get_db_prep_save"><strong>get_db_prep_save</strong></a>(self, value)</dt><dd><tt>Returns field's value prepared for saving into a database.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-get_default"><strong>get_default</strong></a>(self)</dt><dd><tt>Returns the default value for this field.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-get_flatchoices"><strong>get_flatchoices</strong></a>(self, include_blank<font color="#909090">=True</font>, blank_choice<font color="#909090">=[('', '---------')]</font>)</dt><dd><tt>Returns flattened choices with a default blank choice included.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-get_internal_type"><strong>get_internal_type</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-get_prep_lookup"><strong>get_prep_lookup</strong></a>(self, lookup_type, value)</dt><dd><tt>Perform preliminary non-db specific lookup checks and conversions</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-get_prep_value"><strong>get_prep_value</strong></a>(self, value)</dt><dd><tt>Perform preliminary non-db specific value checks and conversions.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-get_validator_unique_lookup_type"><strong>get_validator_unique_lookup_type</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-has_default"><strong>has_default</strong></a>(self)</dt><dd><tt>Returns a boolean of whether this field has a default value.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-pre_save"><strong>pre_save</strong></a>(self, model_instance, add)</dt><dd><tt>Returns field's value just before saving.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-run_validators"><strong>run_validators</strong></a>(self, value)</dt></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-save_form_data"><strong>save_form_data</strong></a>(self, instance, data)</dt></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-set_attributes_from_name"><strong>set_attributes_from_name</strong></a>(self, name)</dt></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-validate"><strong>validate</strong></a>(self, value, model_instance)</dt><dd><tt>Validates value and throws ValidationError. Subclasses should override<br>
|
||||
this to provide validation logic.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-value_from_object"><strong>value_from_object</strong></a>(self, obj)</dt><dd><tt>Returns the value of this field in the given model instance.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentialsField-value_to_string"><strong>value_to_string</strong></a>(self, obj)</dt><dd><tt>Returns a string value of this field from the passed obj.<br>
|
||||
@@ -264,8 +232,6 @@ Data descriptors inherited from <a href="django.db.models.fields.html#Field">dja
|
||||
</dl>
|
||||
<dl><dt><strong>choices</strong></dt>
|
||||
</dl>
|
||||
<dl><dt><strong>description</strong></dt>
|
||||
</dl>
|
||||
<dl><dt><strong>flatchoices</strong></dt>
|
||||
<dd><tt>Flattened version of choices tuple.</tt></dd>
|
||||
</dl>
|
||||
@@ -277,10 +243,6 @@ Data and other attributes inherited from <a href="django.db.models.fields.html#F
|
||||
|
||||
<dl><dt><strong>creation_counter</strong> = 0</dl>
|
||||
|
||||
<dl><dt><strong>default_error_messages</strong> = {'blank': <django.utils.functional.__proxy__ object>, 'invalid_choice': <django.utils.functional.__proxy__ object>, 'null': <django.utils.functional.__proxy__ object>}</dl>
|
||||
|
||||
<dl><dt><strong>default_validators</strong> = []</dl>
|
||||
|
||||
<dl><dt><strong>empty_strings_allowed</strong> = True</dl>
|
||||
|
||||
</td></tr></table></td></tr></table>
|
||||
|
||||
@@ -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:/home/jcgregorio/projects/apiclient/apiclient/ext/file.py">/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:/home/jcgregorio/projects/apiclient/apiclient/ext/__init__.py">/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">
|
||||
|
||||
@@ -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>apiclient</strong></big></big></font></td
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>apiclient</strong></big></big> (version 1.0b9)</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:/home/jcgregorio/projects/apiclient/apiclient/__init__.py">/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">
|
||||
@@ -17,14 +17,22 @@
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="apiclient.contrib.html"><strong>contrib</strong> (package)</a><br>
|
||||
<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>
|
||||
<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>
|
||||
</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>
|
||||
<a href="apiclient.mimeparse.html">mimeparse</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>
|
||||
<a href="apiclient.schema.html">schema</a><br>
|
||||
</td><td width="25%" valign=top></td></tr></table></td></tr></table>
|
||||
</td><td width="25%" valign=top><a href="apiclient.schema.html">schema</a><br>
|
||||
</td></tr></table></td></tr></table><p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#55aa55">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||
<td width="100%"><strong>__version__</strong> = '1.0b9'</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:/home/jcgregorio/projects/apiclient/apiclient/http.py">/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>
|
||||
|
||||
@@ -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>.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:/home/jcgregorio/projects/google-api-python-client/apiclient/mimeparse.py">/home/jcgregorio/projects/google-api-python-client/apiclient/mimeparse.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient/apiclient/mimeparse.py">/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>
|
||||
|
||||
@@ -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:/home/jcgregorio/projects/apiclient/apiclient/model.py">/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>
|
||||
|
||||
@@ -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:/home/jcgregorio/projects/apiclient/apiclient/oauth.py">/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>
|
||||
@@ -369,10 +369,19 @@ Args:<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
string, a JSON representation of this instance, suitable to pass to<br>
|
||||
from_json().</tt></dd></dl>
|
||||
<a href="#OAuthCredentials-from_json">from_json</a>().</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Class methods inherited from <a href="oauth2client.client.html#Credentials">oauth2client.client.Credentials</a>:<br>
|
||||
<dl><dt><a name="OAuthCredentials-from_json"><strong>from_json</strong></a>(cls, s)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Instantiate a <a href="oauth2client.client.html#Credentials">Credentials</a> object from a JSON description of it. The JSON<br>
|
||||
should have been produced by calling .<a href="#OAuthCredentials-to_json">to_json</a>() on the object.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
data: dict, A deserialized JSON object.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An instance of a <a href="oauth2client.client.html#Credentials">Credentials</a> subclass.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentials-new_from_json"><strong>new_from_json</strong></a>(cls, s)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Utility class method to instantiate a <a href="oauth2client.client.html#Credentials">Credentials</a> subclass from a JSON<br>
|
||||
representation produced by <a href="#OAuthCredentials-to_json">to_json</a>().<br>
|
||||
<br>
|
||||
@@ -554,10 +563,19 @@ Args:<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
string, a JSON representation of this instance, suitable to pass to<br>
|
||||
from_json().</tt></dd></dl>
|
||||
<a href="#TwoLeggedOAuthCredentials-from_json">from_json</a>().</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Class methods inherited from <a href="oauth2client.client.html#Credentials">oauth2client.client.Credentials</a>:<br>
|
||||
<dl><dt><a name="TwoLeggedOAuthCredentials-from_json"><strong>from_json</strong></a>(cls, s)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Instantiate a <a href="oauth2client.client.html#Credentials">Credentials</a> object from a JSON description of it. The JSON<br>
|
||||
should have been produced by calling .<a href="#TwoLeggedOAuthCredentials-to_json">to_json</a>() on the object.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
data: dict, A deserialized JSON object.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An instance of a <a href="oauth2client.client.html#Credentials">Credentials</a> subclass.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="TwoLeggedOAuthCredentials-new_from_json"><strong>new_from_json</strong></a>(cls, s)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Utility class method to instantiate a <a href="oauth2client.client.html#Credentials">Credentials</a> subclass from a JSON<br>
|
||||
representation produced by <a href="#TwoLeggedOAuthCredentials-to_json">to_json</a>().<br>
|
||||
<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>.schema</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/schema.py">/home/jcgregorio/projects/google-api-python-client/apiclient/schema.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient/apiclient/schema.py">/home/jcgregorio/projects/apiclient/apiclient/schema.py</a></font></td></tr></table>
|
||||
<p><tt>Schema processing for discovery based APIs<br>
|
||||
<br>
|
||||
<a href="#Schemas">Schemas</a> holds an APIs discovery schemas. It can return those schema as<br>
|
||||
|
||||
@@ -19,8 +19,8 @@
|
||||
Args:<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
userId: string, Id of user for whom to retrieve bookshelves. (required)<br>
|
||||
shelf: string, Id of bookshelf to retrieve. (required)<br>
|
||||
userId: string, ID of user for whom to retrieve bookshelves. (required)<br>
|
||||
shelf: string, ID of bookshelf to retrieve. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -43,7 +43,7 @@ Returns:<br>
|
||||
Args:<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
userId: string, Id of user for whom to retrieve bookshelves. (required)<br>
|
||||
userId: string, ID of user for whom to retrieve bookshelves. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,13 +17,13 @@
|
||||
<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>
|
||||
shelf: string, Id of bookshelf to retrieve volumes. (required)<br>
|
||||
shelf: string, ID of bookshelf to retrieve volumes. (required)<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
showPreorders: boolean, Set to true to show pre-ordered books. Defaults to false.<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
startIndex: integer, Index of the first element to return (starts at 0)<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
userId: string, Id of user for whom to retrieve bookshelf volumes. (required)<br>
|
||||
userId: string, ID of user for whom to retrieve bookshelf volumes. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -118,11 +118,25 @@ Returns:<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"volumeInfo": { # General volume information.<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"subtitle": "A String", # Volume subtitle. (In LITE projection.)<br>
|
||||
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"pageCount": 42, # Total number of pages.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)<br>
|
||||
"medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)<br>
|
||||
"smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)<br>
|
||||
@@ -131,33 +145,21 @@ Returns:<br>
|
||||
"small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)<br>
|
||||
"thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)<br>
|
||||
},<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"showReviewsLink": "A String", # URL to show reviews for this volume<br>
|
||||
"writeReviewLink": "A String", # URL to write a review for this volume<br>
|
||||
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
},<br>
|
||||
"id": "A String", # Unique identifier for a volume. (In LITE projection.)<br>
|
||||
"selfLink": "A String", # URL to this resource. (In LITE projection.)<br>
|
||||
|
||||
@@ -16,10 +16,14 @@
|
||||
|
||||
<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-layers"><strong><a href="books.v1.layers.html">layers</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-myconfig"><strong><a href="books.v1.myconfig.html">myconfig</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-volumeAnnotations"><strong><a href="books.v1.volumeAnnotations.html">volumeAnnotations</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>
|
||||
|
||||
@@ -20,7 +20,7 @@ Args:<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
cpksver: string, The device/version identifier from which to release the restriction. (required)<br>
|
||||
cpksver: string, The device/version ID from which to release the restriction. (required)<br>
|
||||
volumeIds: string, The volume(s) to release restrictions for. (required) (repeated)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -53,7 +53,7 @@ Args:<br>
|
||||
source: string, String to identify the originator of this request. (required)<br>
|
||||
locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
cpksver: string, The device/version identifier from which to request the restrictions. (required)<br>
|
||||
cpksver: string, The device/version ID from which to request the restrictions. (required)<br>
|
||||
volumeId: string, The volume to request concurrent/download restrictions for. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -98,7 +98,7 @@ Args:<br>
|
||||
locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
showPreorders: boolean, Set to true to show pre-ordered books. Defaults to false.<br>
|
||||
cpksver: string, The device/version identifier from which to release the restriction. (required)<br>
|
||||
cpksver: string, The device/version ID from which to release the restriction. (required)<br>
|
||||
volumeIds: string, The volume(s) to request download restrictions for. (repeated)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -194,11 +194,25 @@ Returns:<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"volumeInfo": { # General volume information.<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"subtitle": "A String", # Volume subtitle. (In LITE projection.)<br>
|
||||
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"pageCount": 42, # Total number of pages.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)<br>
|
||||
"medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)<br>
|
||||
"smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)<br>
|
||||
@@ -207,33 +221,21 @@ Returns:<br>
|
||||
"small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)<br>
|
||||
"thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)<br>
|
||||
},<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"showReviewsLink": "A String", # URL to show reviews for this volume<br>
|
||||
"writeReviewLink": "A String", # URL to write a review for this volume<br>
|
||||
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
},<br>
|
||||
"id": "A String", # Unique identifier for a volume. (In LITE projection.)<br>
|
||||
"selfLink": "A String", # URL to this resource. (In LITE projection.)<br>
|
||||
|
||||
@@ -19,14 +19,14 @@
|
||||
Args:<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
annotationId: string, The annotation identifier for the annotation to delete. (required)</tt></dd></dl>
|
||||
annotationId: string, The ID for the annotation to delete. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets an annotation by its id.<br>
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets an annotation by its ID.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
annotationId: string, The annotation identifier for the annotation to retrieve. (required)<br>
|
||||
annotationId: string, The ID for the annotation to retrieve. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -231,11 +231,11 @@ Returns:<br>
|
||||
Args:<br>
|
||||
pageToken: string, The value of the nextToken from the previous page.<br>
|
||||
updatedMax: string, <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp to restrict to items updated prior to this timestamp (exclusive).<br>
|
||||
layerId: string, The layer id to limit annotation by.<br>
|
||||
layerId: string, The layer ID to limit annotation by.<br>
|
||||
volumeId: string, The volume to restrict annotations to.<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.<br>
|
||||
pageIds: string, The page id(s) for the volume that is being queried. (repeated)<br>
|
||||
pageIds: string, The page ID(s) for the volume that is being queried. (repeated)<br>
|
||||
contentVersion: string, The content version for the requested volume.<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
@@ -391,7 +391,7 @@ Args:<br>
|
||||
<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
annotationId: string, The annotation identifier for the annotation to update. (required)<br>
|
||||
annotationId: string, The ID for the annotation to update. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -19,21 +19,21 @@
|
||||
Args:<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
volumeId: string, Id of volume to add. (required)<br>
|
||||
shelf: string, Id of bookshelf to which to add a volume. (required)</tt></dd></dl>
|
||||
volumeId: string, ID of volume to add. (required)<br>
|
||||
shelf: string, ID of bookshelf to which to add a volume. (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>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
shelf: string, Id of bookshelf from which to remove a volume. (required)<br>
|
||||
shelf: string, ID of bookshelf from which to remove a volume. (required)<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves metadata for a specific bookshelf belonging to the authenticated 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>
|
||||
shelf: string, ID of bookshelf to retrieve. (required)<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -85,16 +85,16 @@ Args:<br>
|
||||
volumePosition: integer, Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.) (required)<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
volumeId: string, Id of volume to move. (required)<br>
|
||||
shelf: string, Id of bookshelf with the volume. (required)</tt></dd></dl>
|
||||
volumeId: string, ID of volume to move. (required)<br>
|
||||
shelf: string, ID of bookshelf with the volume. (required)</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>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
volumeId: string, Id of volume to remove. (required)<br>
|
||||
shelf: string, Id of bookshelf from which to remove a volume. (required)</tt></dd></dl>
|
||||
volumeId: string, ID of volume to remove. (required)<br>
|
||||
shelf: string, ID of bookshelf from which to remove a volume. (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>
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ Args:<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
q: string, Full-text search query string in this bookshelf.<br>
|
||||
startIndex: integer, Index of the first element to return (starts at 0)<br>
|
||||
shelf: string, The bookshelf id or name retrieve volumes for. (required)<br>
|
||||
shelf: string, The bookshelf ID or name retrieve volumes for. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -122,11 +122,25 @@ Returns:<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"volumeInfo": { # General volume information.<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"subtitle": "A String", # Volume subtitle. (In LITE projection.)<br>
|
||||
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"pageCount": 42, # Total number of pages.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)<br>
|
||||
"medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)<br>
|
||||
"smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)<br>
|
||||
@@ -135,33 +149,21 @@ Returns:<br>
|
||||
"small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)<br>
|
||||
"thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)<br>
|
||||
},<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"showReviewsLink": "A String", # URL to show reviews for this volume<br>
|
||||
"writeReviewLink": "A String", # URL to write a review for this volume<br>
|
||||
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
},<br>
|
||||
"id": "A String", # Unique identifier for a volume. (In LITE projection.)<br>
|
||||
"selfLink": "A String", # URL to this resource. (In LITE projection.)<br>
|
||||
|
||||
@@ -19,7 +19,7 @@
|
||||
Args:<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
volumeId: string, Id of volume for which to retrieve a reading position. (required)<br>
|
||||
volumeId: string, ID of volume for which to retrieve a reading position. (required)<br>
|
||||
contentVersion: string, Volume content version for which this reading position is requested.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -39,7 +39,7 @@ Returns:<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
volumeId: string, Id of volume for which to update the reading position. (required)<br>
|
||||
volumeId: string, ID of volume for which to update the reading position. (required)<br>
|
||||
contentVersion: string, Volume content version for which this reading position applies.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
position: string, Position string for the new volume reading position. (required)<br>
|
||||
|
||||
@@ -23,8 +23,8 @@ Args:<br>
|
||||
lite - Includes a subset of fields in volumeInfo and accessInfo.<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
volumeId: string, Id of volume to retrieve. (required)<br>
|
||||
partner: string, Identifier of partner for whom to brand results.<br>
|
||||
volumeId: string, ID of volume to retrieve. (required)<br>
|
||||
partner: string, Brand results for partner ID.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -116,11 +116,25 @@ Returns:<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"volumeInfo": { # General volume information.<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"subtitle": "A String", # Volume subtitle. (In LITE projection.)<br>
|
||||
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"pageCount": 42, # Total number of pages.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)<br>
|
||||
"medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)<br>
|
||||
"smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)<br>
|
||||
@@ -129,33 +143,21 @@ Returns:<br>
|
||||
"small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)<br>
|
||||
"thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)<br>
|
||||
},<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"showReviewsLink": "A String", # URL to show reviews for this volume<br>
|
||||
"writeReviewLink": "A String", # URL to write a review for this volume<br>
|
||||
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
},<br>
|
||||
"id": "A String", # Unique identifier for a volume. (In LITE projection.)<br>
|
||||
"selfLink": "A String", # URL to this resource. (In LITE projection.)<br>
|
||||
@@ -194,7 +196,7 @@ Args:<br>
|
||||
startIndex: integer, Index of the first result to return (starts at 0)<br>
|
||||
maxResults: integer, Maximum number of results to return.<br>
|
||||
q: string, Full-text search query string. (required)<br>
|
||||
partner: string, Identifier of partner for whom to restrict and brand results.<br>
|
||||
partner: string, Restrict and brand results for partner ID.<br>
|
||||
download: string, Restrict to volumes by download availability.<br>
|
||||
Allowed values<br>
|
||||
epub - All volumes with epub.<br>
|
||||
@@ -293,11 +295,25 @@ Returns:<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"volumeInfo": { # General volume information.<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"subtitle": "A String", # Volume subtitle. (In LITE projection.)<br>
|
||||
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"pageCount": 42, # Total number of pages.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)<br>
|
||||
"medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)<br>
|
||||
"smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)<br>
|
||||
@@ -306,33 +322,21 @@ Returns:<br>
|
||||
"small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)<br>
|
||||
"thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)<br>
|
||||
},<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"showReviewsLink": "A String", # URL to show reviews for this volume<br>
|
||||
"writeReviewLink": "A String", # URL to write a review for this volume<br>
|
||||
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
},<br>
|
||||
"id": "A String", # Unique identifier for a volume. (In LITE projection.)<br>
|
||||
"selfLink": "A String", # URL to this resource. (In LITE projection.)<br>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -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>.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/oauth2client/anyjson.py">/home/jcgregorio/projects/google-api-python-client/oauth2client/anyjson.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient/oauth2client/anyjson.py">/home/jcgregorio/projects/apiclient/oauth2client/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="oauth2client.html"><font color="#ffffff">oauth2client</font></a>.appengine</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient-release/oauth2client/appengine.py">/usr/local/google/home/jcgregorio/projects/apiclient-release/oauth2client/appengine.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient/oauth2client/appengine.py">/home/jcgregorio/projects/apiclient/oauth2client/appengine.py</a></font></td></tr></table>
|
||||
<p><tt>Utilities for Google App Engine<br>
|
||||
<br>
|
||||
Utilities for making it easier to use OAuth 2.0 on Google App Engine.</tt></p>
|
||||
@@ -19,7 +19,7 @@ Utilities for making it easier to use OAuth&n
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="google.appengine.api.app_identity.app_identity.html">google.appengine.api.app_identity.app_identity</a><br>
|
||||
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="google.appengine.api.app_identity.html">google.appengine.api.app_identity</a><br>
|
||||
<a href="base64.html">base64</a><br>
|
||||
<a href="oauth2client.clientsecrets.html">oauth2client.clientsecrets</a><br>
|
||||
</td><td width="25%" valign=top><a href="google.appengine.ext.db.html">google.appengine.ext.db</a><br>
|
||||
@@ -69,7 +69,7 @@ Utilities for making it easier to use OAuth&n
|
||||
</font></dt><dt><font face="helvetica, arial"><a href="oauth2client.appengine.html#FlowProperty">FlowProperty</a>
|
||||
</font></dt></dl>
|
||||
</dd>
|
||||
<dt><font face="helvetica, arial"><a href="google.appengine.ext.webapp.html#RequestHandler">google.appengine.ext.webapp.RequestHandler</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
|
||||
<dt><font face="helvetica, arial"><a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">google.appengine.ext.webapp._webapp25.RequestHandler</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
|
||||
</font></dt><dd>
|
||||
<dl>
|
||||
<dt><font face="helvetica, arial"><a href="oauth2client.appengine.html#OAuth2Handler">OAuth2Handler</a>
|
||||
@@ -100,11 +100,7 @@ Utilities for making it easier to use OAuth&n
|
||||
This <a href="__builtin__.html#object">object</a> will allow an App Engine application to identify itself to Google<br>
|
||||
and other OAuth 2.0 servers that can verify assertions. It can be used for<br>
|
||||
the purpose of accessing data stored under an account assigned to the App<br>
|
||||
Engine application itself. The algorithm used for generating the assertion is<br>
|
||||
the Signed JSON Web Token (JWT) algorithm. Additional details can be found at<br>
|
||||
the following link:<br>
|
||||
<br>
|
||||
<a href="http://self-issued.info/docs/draft-jones-json-web-token.html">http://self-issued.info/docs/draft-jones-json-web-token.html</a><br>
|
||||
Engine application itself.<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>
|
||||
@@ -119,17 +115,10 @@ generate and refresh its own access tokens.<br>&nb
|
||||
</dl>
|
||||
<hr>
|
||||
Methods defined here:<br>
|
||||
<dl><dt><a name="AppAssertionCredentials-__init__"><strong>__init__</strong></a>(self, scope, audience<font color="#909090">='https://accounts.google.com/o/oauth2/token'</font>, assertion_type<font color="#909090">='http://oauth.net/grant_type/jwt/1.0/bearer'</font>, token_uri<font color="#909090">='https://accounts.google.com/o/oauth2/token'</font>, **kwargs)</dt><dd><tt>Constructor for <a href="#AppAssertionCredentials">AppAssertionCredentials</a><br>
|
||||
<dl><dt><a name="AppAssertionCredentials-__init__"><strong>__init__</strong></a>(self, scope, **kwargs)</dt><dd><tt>Constructor for <a href="#AppAssertionCredentials">AppAssertionCredentials</a><br>
|
||||
<br>
|
||||
Args:<br>
|
||||
scope: string, scope of the credentials being requested.<br>
|
||||
audience: string, The audience, or verifier of the assertion. For<br>
|
||||
convenience defaults to Google's audience.<br>
|
||||
assertion_type: string, Type name that will identify the format of the<br>
|
||||
assertion string. For convience, defaults to the JSON Web Token (JWT)<br>
|
||||
assertion type string.<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>
|
||||
scope: string or list of strings, scope(s) of the credentials being requested.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Class methods defined here:<br>
|
||||
@@ -567,7 +556,7 @@ Subclasses must define an authorize() method that&
|
||||
an HTTP transport.<br>
|
||||
<br>
|
||||
Subclasses must also specify a classmethod named 'from_json' that takes a JSON<br>
|
||||
string as input and returns an instaniated Crentials <a href="__builtin__.html#object">object</a>.</tt></dl>
|
||||
string as input and returns an instaniated Credentials <a href="__builtin__.html#object">object</a>.</tt></dl>
|
||||
|
||||
<hr>
|
||||
Methods inherited from <a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>:<br>
|
||||
@@ -624,6 +613,20 @@ Returns:<br>
|
||||
True if this value is considered empty in the context of this <a href="google.appengine.ext.db.html#Property">Property</a><br>
|
||||
type, otherwise False.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsProperty-get_updated_value_for_datastore"><strong>get_updated_value_for_datastore</strong></a>(self, model_instance)</dt><dd><tt>Determine new value for auto-updated property.<br>
|
||||
<br>
|
||||
Some properies (e.g. DateTimeProperty, UserProperty) optionally update their<br>
|
||||
value on every put(). This call must return the new desired value for such<br>
|
||||
properties. For all other properties, this call must return<br>
|
||||
AUTO_UPDATE_UNCHANGED.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
model_instance: Instance to get new value for.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
Datastore representation of the new model value in a form that is<br>
|
||||
appropriate for storing in the datastore, or AUTO_UPDATE_UNCHANGED.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
@@ -709,6 +712,20 @@ the arguments to this class and what they&nbs
|
||||
Returns:<br>
|
||||
Default value as provided by <a href="#FlowProperty-__init__">__init__</a>(default).</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowProperty-get_updated_value_for_datastore"><strong>get_updated_value_for_datastore</strong></a>(self, model_instance)</dt><dd><tt>Determine new value for auto-updated property.<br>
|
||||
<br>
|
||||
Some properies (e.g. DateTimeProperty, UserProperty) optionally update their<br>
|
||||
value on every put(). This call must return the new desired value for such<br>
|
||||
properties. For all other properties, this call must return<br>
|
||||
AUTO_UPDATE_UNCHANGED.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
model_instance: Instance to get new value for.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
Datastore representation of the new model value in a form that is<br>
|
||||
appropriate for storing in the datastore, or AUTO_UPDATE_UNCHANGED.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
@@ -791,7 +808,7 @@ Data descriptors inherited from <a href="exceptions.html#BaseException">exceptio
|
||||
<td colspan=2><tt>Utility for making OAuth 2.0 easier.<br>
|
||||
<br>
|
||||
Instantiate and then use with oauth_required or oauth_aware<br>
|
||||
as decorators on webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a> methods.<br>
|
||||
as decorators on webapp.<a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">RequestHandler</a> methods.<br>
|
||||
<br>
|
||||
Example:<br>
|
||||
<br>
|
||||
@@ -801,7 +818,7 @@ Example:<br>
|
||||
scope='https://www.googleapis.com/auth/plus')<br>
|
||||
<br>
|
||||
<br>
|
||||
class MainHandler(webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a>):<br>
|
||||
class MainHandler(webapp.<a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">RequestHandler</a>):<br>
|
||||
<br>
|
||||
@decorator.oauth_required<br>
|
||||
def get(self):<br>
|
||||
@@ -830,12 +847,12 @@ Args:<br>
|
||||
|
||||
<dl><dt><a name="OAuth2Decorator-authorize_url"><strong>authorize_url</strong></a>(self)</dt><dd><tt>Returns the URL to start the OAuth dance.<br>
|
||||
<br>
|
||||
Must only be called from with a webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a> subclassed method<br>
|
||||
Must only be called from with a webapp.<a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">RequestHandler</a> subclassed method<br>
|
||||
that had been decorated with either @oauth_required or @oauth_aware.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuth2Decorator-has_credentials"><strong>has_credentials</strong></a>(self)</dt><dd><tt>True if for the logged in user there are valid access Credentials.<br>
|
||||
<br>
|
||||
Must only be called from with a webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a> subclassed method<br>
|
||||
Must only be called from with a webapp.<a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">RequestHandler</a> subclassed method<br>
|
||||
that had been decorated with either @oauth_required or @oauth_aware.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuth2Decorator-http"><strong>http</strong></a>(self)</dt><dd><tt>Returns an authorized http instance.<br>
|
||||
@@ -853,7 +870,7 @@ From within a method decorated with @oauth_aware&n
|
||||
and <a href="#OAuth2Decorator-authorize_url">authorize_url</a>() methods can be called.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
method: callable, to be decorated method of a webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a><br>
|
||||
method: callable, to be decorated method of a webapp.<a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">RequestHandler</a><br>
|
||||
instance.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuth2Decorator-oauth_required"><strong>oauth_required</strong></a>(self, method)</dt><dd><tt>Decorator that starts the OAuth 2.0 dance.<br>
|
||||
@@ -862,7 +879,7 @@ Starts the OAuth dance for the logged in 
|
||||
granted access for this application.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
method: callable, to be decorated method of a webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a><br>
|
||||
method: callable, to be decorated method of a webapp.<a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">RequestHandler</a><br>
|
||||
instance.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
@@ -892,7 +909,7 @@ Example:<br>
|
||||
scope='https://www.googleapis.com/auth/plus')<br>
|
||||
<br>
|
||||
<br>
|
||||
class MainHandler(webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a>):<br>
|
||||
class MainHandler(webapp.<a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">RequestHandler</a>):<br>
|
||||
<br>
|
||||
@decorator.oauth_required<br>
|
||||
def get(self):<br>
|
||||
@@ -911,7 +928,8 @@ Methods defined here:<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
filename: string, File name of client secrets.<br>
|
||||
scope: string, Space separated list of scopes.<br>
|
||||
scope: string or list of strings, scope(s) of the credentials being<br>
|
||||
requested.<br>
|
||||
message: string, A friendly string to display to the user if the<br>
|
||||
clientsecrets file is missing or invalid. The message may contain HTML and<br>
|
||||
will be presented on the web interface for any method that uses the<br>
|
||||
@@ -921,12 +939,12 @@ Args:<br>
|
||||
Methods inherited from <a href="oauth2client.appengine.html#OAuth2Decorator">OAuth2Decorator</a>:<br>
|
||||
<dl><dt><a name="OAuth2DecoratorFromClientSecrets-authorize_url"><strong>authorize_url</strong></a>(self)</dt><dd><tt>Returns the URL to start the OAuth dance.<br>
|
||||
<br>
|
||||
Must only be called from with a webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a> subclassed method<br>
|
||||
Must only be called from with a webapp.<a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">RequestHandler</a> subclassed method<br>
|
||||
that had been decorated with either @oauth_required or @oauth_aware.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuth2DecoratorFromClientSecrets-has_credentials"><strong>has_credentials</strong></a>(self)</dt><dd><tt>True if for the logged in user there are valid access Credentials.<br>
|
||||
<br>
|
||||
Must only be called from with a webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a> subclassed method<br>
|
||||
Must only be called from with a webapp.<a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">RequestHandler</a> subclassed method<br>
|
||||
that had been decorated with either @oauth_required or @oauth_aware.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuth2DecoratorFromClientSecrets-http"><strong>http</strong></a>(self)</dt><dd><tt>Returns an authorized http instance.<br>
|
||||
@@ -944,7 +962,7 @@ From within a method decorated with @oauth_aware&n
|
||||
and <a href="#OAuth2DecoratorFromClientSecrets-authorize_url">authorize_url</a>() methods can be called.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
method: callable, to be decorated method of a webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a><br>
|
||||
method: callable, to be decorated method of a webapp.<a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">RequestHandler</a><br>
|
||||
instance.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuth2DecoratorFromClientSecrets-oauth_required"><strong>oauth_required</strong></a>(self, method)</dt><dd><tt>Decorator that starts the OAuth 2.0 dance.<br>
|
||||
@@ -953,7 +971,7 @@ Starts the OAuth dance for the logged in 
|
||||
granted access for this application.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
method: callable, to be decorated method of a webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a><br>
|
||||
method: callable, to be decorated method of a webapp.<a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">RequestHandler</a><br>
|
||||
instance.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
@@ -968,14 +986,14 @@ Data descriptors inherited from <a href="oauth2client.appengine.html#OAuth2Decor
|
||||
<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="OAuth2Handler">class <strong>OAuth2Handler</strong></a>(<a href="google.appengine.ext.webapp.html#RequestHandler">google.appengine.ext.webapp.RequestHandler</a>)</font></td></tr>
|
||||
<font color="#000000" face="helvetica, arial"><a name="OAuth2Handler">class <strong>OAuth2Handler</strong></a>(<a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">google.appengine.ext.webapp._webapp25.RequestHandler</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>Handler for the redirect_uri of the OAuth 2.0 dance.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%"><dl><dt>Method resolution order:</dt>
|
||||
<dd><a href="oauth2client.appengine.html#OAuth2Handler">OAuth2Handler</a></dd>
|
||||
<dd><a href="google.appengine.ext.webapp.html#RequestHandler">google.appengine.ext.webapp.RequestHandler</a></dd>
|
||||
<dd><a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">google.appengine.ext.webapp._webapp25.RequestHandler</a></dd>
|
||||
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
@@ -983,7 +1001,7 @@ Methods defined here:<br>
|
||||
<dl><dt><a name="OAuth2Handler-get"><strong>get</strong></a> = check_login(self, *args)</dt></dl>
|
||||
|
||||
<hr>
|
||||
Methods inherited from <a href="google.appengine.ext.webapp.html#RequestHandler">google.appengine.ext.webapp.RequestHandler</a>:<br>
|
||||
Methods inherited from <a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">google.appengine.ext.webapp._webapp25.RequestHandler</a>:<br>
|
||||
<dl><dt><a name="OAuth2Handler-delete"><strong>delete</strong></a>(self, *args)</dt><dd><tt>Handler method for DELETE requests.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuth2Handler-error"><strong>error</strong></a>(self, code)</dt><dd><tt>Clears the response output stream and sets the given HTTP error code.<br>
|
||||
@@ -1019,7 +1037,7 @@ Args:<br>
|
||||
<dl><dt><a name="OAuth2Handler-trace"><strong>trace</strong></a>(self, *args)</dt><dd><tt>Handler method for TRACE requests.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Class methods inherited from <a href="google.appengine.ext.webapp.html#RequestHandler">google.appengine.ext.webapp.RequestHandler</a>:<br>
|
||||
Class methods inherited from <a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">google.appengine.ext.webapp._webapp25.RequestHandler</a>:<br>
|
||||
<dl><dt><a name="OAuth2Handler-get_url"><strong>get_url</strong></a>(cls, *args, **kargs)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Returns the url for the given handler.<br>
|
||||
<br>
|
||||
The default implementation uses the patterns passed to the active<br>
|
||||
@@ -1057,7 +1075,7 @@ instances without relying on global variables. &nb
|
||||
create a set of post handlers that will do simple text transformations<br>
|
||||
you can write:<br>
|
||||
<br>
|
||||
class ChangeTextHandler(webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a>):<br>
|
||||
class ChangeTextHandler(webapp.<a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">RequestHandler</a>):<br>
|
||||
<br>
|
||||
def <a href="#OAuth2Handler-__init__">__init__</a>(self, transform):<br>
|
||||
self.<strong>transform</strong> = transform<br>
|
||||
@@ -1077,7 +1095,7 @@ Text POSTed to /to_lower will be lower cased.
|
||||
Text POSTed to /to_upper will be upper cased.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="google.appengine.ext.webapp.html#RequestHandler">google.appengine.ext.webapp.RequestHandler</a>:<br>
|
||||
Data descriptors inherited from <a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">google.appengine.ext.webapp._webapp25.RequestHandler</a>:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
@@ -1179,7 +1197,8 @@ Data descriptors inherited from <a href="oauth2client.client.html#Storage">oauth
|
||||
<br>
|
||||
Args:<br>
|
||||
filename: string, File name of client secrets.<br>
|
||||
scope: string, Space separated list of scopes.<br>
|
||||
scope: string or list of strings, scope(s) of the credentials being<br>
|
||||
requested.<br>
|
||||
message: string, A friendly string to display to the user if the<br>
|
||||
clientsecrets file is missing or invalid. The message may contain HTML and<br>
|
||||
will be presented on the web interface for any method that uses the<br>
|
||||
@@ -1195,7 +1214,7 @@ Returns: An <a href="#OAuth2Decorator">OAuth2Decorator</a></tt></dd></
|
||||
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||
<td width="100%"><strong>OAUTH2CLIENT_NAMESPACE</strong> = 'oauth2client#ns'<br>
|
||||
<strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'<br>
|
||||
<strong>application</strong> = <google.appengine.ext.webapp.WSGIApplication object></td></tr></table><p>
|
||||
<strong>application</strong> = <google.appengine.ext.webapp._webapp25.WSGIApplication object></td></tr></table><p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#7799ee">
|
||||
<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="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:/home/jcgregorio/projects/apiclient/oauth2client/client.py">/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 resources.</tt></p>
|
||||
@@ -513,10 +513,19 @@ Args:<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
string, a JSON representation of this instance, suitable to pass to<br>
|
||||
from_json().</tt></dd></dl>
|
||||
<a href="#Credentials-from_json">from_json</a>().</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Class methods defined here:<br>
|
||||
<dl><dt><a name="Credentials-from_json"><strong>from_json</strong></a>(cls, s)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Instantiate a <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> from a JSON description of it. The JSON<br>
|
||||
should have been produced by calling .<a href="#Credentials-to_json">to_json</a>() on the <a href="__builtin__.html#object">object</a>.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
data: dict, A deserialized JSON <a href="__builtin__.html#object">object</a>.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An instance of a <a href="#Credentials">Credentials</a> subclass.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Credentials-new_from_json"><strong>new_from_json</strong></a>(cls, s)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Utility class method to instantiate a <a href="#Credentials">Credentials</a> subclass from a JSON<br>
|
||||
representation produced by <a href="#Credentials-to_json">to_json</a>().<br>
|
||||
<br>
|
||||
|
||||
@@ -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>.clientsecrets</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/clientsecrets.py">/home/jcgregorio/projects/google-api-python-client/oauth2client/clientsecrets.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient/oauth2client/clientsecrets.py">/home/jcgregorio/projects/apiclient/oauth2client/clientsecrets.py</a></font></td></tr></table>
|
||||
<p><tt>Utilities for reading OAuth 2.0 client secret files.<br>
|
||||
<br>
|
||||
A client_secrets.json file contains all the information needed to interact with<br>
|
||||
|
||||
@@ -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>.crypt</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/crypt.py">/home/jcgregorio/projects/google-api-python-client/oauth2client/crypt.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient/oauth2client/crypt.py">/home/jcgregorio/projects/apiclient/oauth2client/crypt.py</a></font></td></tr></table>
|
||||
<p><tt># -*- coding: utf-8 -*-<br>
|
||||
#<br>
|
||||
# Copyright (C) 2011 Google Inc.<br>
|
||||
|
||||
@@ -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>.django_orm</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient-release/oauth2client/django_orm.py">/usr/local/google/home/jcgregorio/projects/apiclient-release/oauth2client/django_orm.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient/oauth2client/django_orm.py">/home/jcgregorio/projects/apiclient/oauth2client/django_orm.py</a></font></td></tr></table>
|
||||
<p><tt>OAuth 2.0 utilities for Django.<br>
|
||||
<br>
|
||||
Utilities for using OAuth 2.0 in conjunction with<br>
|
||||
@@ -62,13 +62,7 @@ the Django datastore.</tt></p>
|
||||
Methods defined here:<br>
|
||||
<dl><dt><a name="CredentialsField-contribute_to_class"><strong>contribute_to_class</strong></a>(self, cls, name)</dt></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-db_type"><strong>db_type</strong></a> = inner(*args, **kwargs)</dt></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-get_db_prep_lookup"><strong>get_db_prep_lookup</strong></a> = inner(*args, **kwargs)</dt></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-get_db_prep_save"><strong>get_db_prep_save</strong></a> = inner(*args, **kwargs)</dt></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-get_db_prep_value"><strong>get_db_prep_value</strong></a> = inner(*args, **kwargs)</dt></dl>
|
||||
<dl><dt><a name="CredentialsField-get_db_prep_value"><strong>get_db_prep_value</strong></a>(self, value, connection, prepared<font color="#909090">=False</font>)</dt></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-get_internal_type"><strong>get_internal_type</strong></a>(self)</dt></dl>
|
||||
|
||||
@@ -85,13 +79,12 @@ Methods inherited from <a href="django.db.models.fields.html#Field">django.db.mo
|
||||
|
||||
<dl><dt><a name="CredentialsField-__deepcopy__"><strong>__deepcopy__</strong></a>(self, memodict)</dt></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-__init__"><strong>__init__</strong></a>(self, verbose_name<font color="#909090">=None</font>, name<font color="#909090">=None</font>, primary_key<font color="#909090">=False</font>, max_length<font color="#909090">=None</font>, unique<font color="#909090">=False</font>, blank<font color="#909090">=False</font>, null<font color="#909090">=False</font>, db_index<font color="#909090">=False</font>, rel<font color="#909090">=None</font>, default<font color="#909090">=<class django.db.models.fields.NOT_PROVIDED></font>, editable<font color="#909090">=True</font>, serialize<font color="#909090">=True</font>, unique_for_date<font color="#909090">=None</font>, unique_for_month<font color="#909090">=None</font>, unique_for_year<font color="#909090">=None</font>, choices<font color="#909090">=None</font>, help_text<font color="#909090">=''</font>, db_column<font color="#909090">=None</font>, db_tablespace<font color="#909090">=None</font>, auto_created<font color="#909090">=False</font>, validators<font color="#909090">=[]</font>, error_messages<font color="#909090">=None</font>)</dt></dl>
|
||||
<dl><dt><a name="CredentialsField-__init__"><strong>__init__</strong></a>(self, verbose_name<font color="#909090">=None</font>, name<font color="#909090">=None</font>, primary_key<font color="#909090">=False</font>, max_length<font color="#909090">=None</font>, unique<font color="#909090">=False</font>, blank<font color="#909090">=False</font>, null<font color="#909090">=False</font>, db_index<font color="#909090">=False</font>, rel<font color="#909090">=None</font>, default<font color="#909090">=<class django.db.models.fields.NOT_PROVIDED></font>, editable<font color="#909090">=True</font>, serialize<font color="#909090">=True</font>, unique_for_date<font color="#909090">=None</font>, unique_for_month<font color="#909090">=None</font>, unique_for_year<font color="#909090">=None</font>, choices<font color="#909090">=None</font>, help_text<font color="#909090">=''</font>, db_column<font color="#909090">=None</font>, db_tablespace<font color="#909090">=None</font>, auto_created<font color="#909090">=False</font>)</dt></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-bind"><strong>bind</strong></a>(self, fieldmapping, original, bound_field_class)</dt></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-clean"><strong>clean</strong></a>(self, value, model_instance)</dt><dd><tt>Convert the value's type and run validation. Validation errors from to_python<br>
|
||||
and validate are propagated. The correct value is returned if no error is<br>
|
||||
raised.</tt></dd></dl>
|
||||
<dl><dt><a name="CredentialsField-db_type"><strong>db_type</strong></a>(self)</dt><dd><tt>Returns the database column data type for this field, taking into<br>
|
||||
account the DATABASE_ENGINE setting.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-formfield"><strong>formfield</strong></a>(self, form_class<font color="#909090">=<class 'django.forms.fields.CharField'></font>, **kwargs)</dt><dd><tt>Returns a django.forms.<a href="django.db.models.fields.html#Field">Field</a> instance for this database <a href="django.db.models.fields.html#Field">Field</a>.</tt></dd></dl>
|
||||
|
||||
@@ -106,29 +99,24 @@ as SelectField choices for this field.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-get_choices_default"><strong>get_choices_default</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-get_db_prep_lookup"><strong>get_db_prep_lookup</strong></a>(self, lookup_type, value)</dt><dd><tt>Returns field's value prepared for database lookup.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-get_db_prep_save"><strong>get_db_prep_save</strong></a>(self, value)</dt><dd><tt>Returns field's value prepared for saving into a database.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-get_default"><strong>get_default</strong></a>(self)</dt><dd><tt>Returns the default value for this field.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-get_flatchoices"><strong>get_flatchoices</strong></a>(self, include_blank<font color="#909090">=True</font>, blank_choice<font color="#909090">=[('', '---------')]</font>)</dt><dd><tt>Returns flattened choices with a default blank choice included.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-get_prep_lookup"><strong>get_prep_lookup</strong></a>(self, lookup_type, value)</dt><dd><tt>Perform preliminary non-db specific lookup checks and conversions</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-get_prep_value"><strong>get_prep_value</strong></a>(self, value)</dt><dd><tt>Perform preliminary non-db specific value checks and conversions.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-get_validator_unique_lookup_type"><strong>get_validator_unique_lookup_type</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-has_default"><strong>has_default</strong></a>(self)</dt><dd><tt>Returns a boolean of whether this field has a default value.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-pre_save"><strong>pre_save</strong></a>(self, model_instance, add)</dt><dd><tt>Returns field's value just before saving.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-run_validators"><strong>run_validators</strong></a>(self, value)</dt></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-save_form_data"><strong>save_form_data</strong></a>(self, instance, data)</dt></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-set_attributes_from_name"><strong>set_attributes_from_name</strong></a>(self, name)</dt></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-validate"><strong>validate</strong></a>(self, value, model_instance)</dt><dd><tt>Validates value and throws ValidationError. Subclasses should override<br>
|
||||
this to provide validation logic.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-value_from_object"><strong>value_from_object</strong></a>(self, obj)</dt><dd><tt>Returns the value of this field in the given model instance.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="CredentialsField-value_to_string"><strong>value_to_string</strong></a>(self, obj)</dt><dd><tt>Returns a string value of this field from the passed obj.<br>
|
||||
@@ -144,8 +132,6 @@ Data descriptors inherited from <a href="django.db.models.fields.html#Field">dja
|
||||
</dl>
|
||||
<dl><dt><strong>choices</strong></dt>
|
||||
</dl>
|
||||
<dl><dt><strong>description</strong></dt>
|
||||
</dl>
|
||||
<dl><dt><strong>flatchoices</strong></dt>
|
||||
<dd><tt>Flattened version of choices tuple.</tt></dd>
|
||||
</dl>
|
||||
@@ -157,10 +143,6 @@ Data and other attributes inherited from <a href="django.db.models.fields.html#F
|
||||
|
||||
<dl><dt><strong>creation_counter</strong> = 0</dl>
|
||||
|
||||
<dl><dt><strong>default_error_messages</strong> = {'blank': <django.utils.functional.__proxy__ object>, 'invalid_choice': <django.utils.functional.__proxy__ object>, 'null': <django.utils.functional.__proxy__ object>}</dl>
|
||||
|
||||
<dl><dt><strong>default_validators</strong> = []</dl>
|
||||
|
||||
<dl><dt><strong>empty_strings_allowed</strong> = True</dl>
|
||||
|
||||
</td></tr></table> <p>
|
||||
@@ -179,13 +161,7 @@ Data and other attributes inherited from <a href="django.db.models.fields.html#F
|
||||
Methods defined here:<br>
|
||||
<dl><dt><a name="FlowField-contribute_to_class"><strong>contribute_to_class</strong></a>(self, cls, name)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-db_type"><strong>db_type</strong></a> = inner(*args, **kwargs)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-get_db_prep_lookup"><strong>get_db_prep_lookup</strong></a> = inner(*args, **kwargs)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-get_db_prep_save"><strong>get_db_prep_save</strong></a> = inner(*args, **kwargs)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-get_db_prep_value"><strong>get_db_prep_value</strong></a> = inner(*args, **kwargs)</dt></dl>
|
||||
<dl><dt><a name="FlowField-get_db_prep_value"><strong>get_db_prep_value</strong></a>(self, value, connection, prepared<font color="#909090">=False</font>)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-get_internal_type"><strong>get_internal_type</strong></a>(self)</dt></dl>
|
||||
|
||||
@@ -202,13 +178,12 @@ Methods inherited from <a href="django.db.models.fields.html#Field">django.db.mo
|
||||
|
||||
<dl><dt><a name="FlowField-__deepcopy__"><strong>__deepcopy__</strong></a>(self, memodict)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-__init__"><strong>__init__</strong></a>(self, verbose_name<font color="#909090">=None</font>, name<font color="#909090">=None</font>, primary_key<font color="#909090">=False</font>, max_length<font color="#909090">=None</font>, unique<font color="#909090">=False</font>, blank<font color="#909090">=False</font>, null<font color="#909090">=False</font>, db_index<font color="#909090">=False</font>, rel<font color="#909090">=None</font>, default<font color="#909090">=<class django.db.models.fields.NOT_PROVIDED></font>, editable<font color="#909090">=True</font>, serialize<font color="#909090">=True</font>, unique_for_date<font color="#909090">=None</font>, unique_for_month<font color="#909090">=None</font>, unique_for_year<font color="#909090">=None</font>, choices<font color="#909090">=None</font>, help_text<font color="#909090">=''</font>, db_column<font color="#909090">=None</font>, db_tablespace<font color="#909090">=None</font>, auto_created<font color="#909090">=False</font>, validators<font color="#909090">=[]</font>, error_messages<font color="#909090">=None</font>)</dt></dl>
|
||||
<dl><dt><a name="FlowField-__init__"><strong>__init__</strong></a>(self, verbose_name<font color="#909090">=None</font>, name<font color="#909090">=None</font>, primary_key<font color="#909090">=False</font>, max_length<font color="#909090">=None</font>, unique<font color="#909090">=False</font>, blank<font color="#909090">=False</font>, null<font color="#909090">=False</font>, db_index<font color="#909090">=False</font>, rel<font color="#909090">=None</font>, default<font color="#909090">=<class django.db.models.fields.NOT_PROVIDED></font>, editable<font color="#909090">=True</font>, serialize<font color="#909090">=True</font>, unique_for_date<font color="#909090">=None</font>, unique_for_month<font color="#909090">=None</font>, unique_for_year<font color="#909090">=None</font>, choices<font color="#909090">=None</font>, help_text<font color="#909090">=''</font>, db_column<font color="#909090">=None</font>, db_tablespace<font color="#909090">=None</font>, auto_created<font color="#909090">=False</font>)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-bind"><strong>bind</strong></a>(self, fieldmapping, original, bound_field_class)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-clean"><strong>clean</strong></a>(self, value, model_instance)</dt><dd><tt>Convert the value's type and run validation. Validation errors from to_python<br>
|
||||
and validate are propagated. The correct value is returned if no error is<br>
|
||||
raised.</tt></dd></dl>
|
||||
<dl><dt><a name="FlowField-db_type"><strong>db_type</strong></a>(self)</dt><dd><tt>Returns the database column data type for this field, taking into<br>
|
||||
account the DATABASE_ENGINE setting.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-formfield"><strong>formfield</strong></a>(self, form_class<font color="#909090">=<class 'django.forms.fields.CharField'></font>, **kwargs)</dt><dd><tt>Returns a django.forms.<a href="django.db.models.fields.html#Field">Field</a> instance for this database <a href="django.db.models.fields.html#Field">Field</a>.</tt></dd></dl>
|
||||
|
||||
@@ -223,29 +198,24 @@ as SelectField choices for this field.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-get_choices_default"><strong>get_choices_default</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-get_db_prep_lookup"><strong>get_db_prep_lookup</strong></a>(self, lookup_type, value)</dt><dd><tt>Returns field's value prepared for database lookup.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-get_db_prep_save"><strong>get_db_prep_save</strong></a>(self, value)</dt><dd><tt>Returns field's value prepared for saving into a database.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-get_default"><strong>get_default</strong></a>(self)</dt><dd><tt>Returns the default value for this field.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-get_flatchoices"><strong>get_flatchoices</strong></a>(self, include_blank<font color="#909090">=True</font>, blank_choice<font color="#909090">=[('', '---------')]</font>)</dt><dd><tt>Returns flattened choices with a default blank choice included.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-get_prep_lookup"><strong>get_prep_lookup</strong></a>(self, lookup_type, value)</dt><dd><tt>Perform preliminary non-db specific lookup checks and conversions</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-get_prep_value"><strong>get_prep_value</strong></a>(self, value)</dt><dd><tt>Perform preliminary non-db specific value checks and conversions.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-get_validator_unique_lookup_type"><strong>get_validator_unique_lookup_type</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-has_default"><strong>has_default</strong></a>(self)</dt><dd><tt>Returns a boolean of whether this field has a default value.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-pre_save"><strong>pre_save</strong></a>(self, model_instance, add)</dt><dd><tt>Returns field's value just before saving.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-run_validators"><strong>run_validators</strong></a>(self, value)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-save_form_data"><strong>save_form_data</strong></a>(self, instance, data)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-set_attributes_from_name"><strong>set_attributes_from_name</strong></a>(self, name)</dt></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-validate"><strong>validate</strong></a>(self, value, model_instance)</dt><dd><tt>Validates value and throws ValidationError. Subclasses should override<br>
|
||||
this to provide validation logic.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-value_from_object"><strong>value_from_object</strong></a>(self, obj)</dt><dd><tt>Returns the value of this field in the given model instance.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="FlowField-value_to_string"><strong>value_to_string</strong></a>(self, obj)</dt><dd><tt>Returns a string value of this field from the passed obj.<br>
|
||||
@@ -261,8 +231,6 @@ Data descriptors inherited from <a href="django.db.models.fields.html#Field">dja
|
||||
</dl>
|
||||
<dl><dt><strong>choices</strong></dt>
|
||||
</dl>
|
||||
<dl><dt><strong>description</strong></dt>
|
||||
</dl>
|
||||
<dl><dt><strong>flatchoices</strong></dt>
|
||||
<dd><tt>Flattened version of choices tuple.</tt></dd>
|
||||
</dl>
|
||||
@@ -274,10 +242,6 @@ Data and other attributes inherited from <a href="django.db.models.fields.html#F
|
||||
|
||||
<dl><dt><strong>creation_counter</strong> = 0</dl>
|
||||
|
||||
<dl><dt><strong>default_error_messages</strong> = {'blank': <django.utils.functional.__proxy__ object>, 'invalid_choice': <django.utils.functional.__proxy__ object>, 'null': <django.utils.functional.__proxy__ object>}</dl>
|
||||
|
||||
<dl><dt><strong>default_validators</strong> = []</dl>
|
||||
|
||||
<dl><dt><strong>empty_strings_allowed</strong> = True</dl>
|
||||
|
||||
</td></tr></table> <p>
|
||||
|
||||
@@ -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:/home/jcgregorio/projects/apiclient/oauth2client/file.py">/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>
|
||||
|
||||
@@ -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>oauth2client</strong></big></big></font></td
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>oauth2client</strong></big></big> (version 1.0b9)</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:/home/jcgregorio/projects/apiclient/oauth2client/__init__.py">/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">
|
||||
@@ -26,5 +26,12 @@
|
||||
</td><td width="25%" valign=top><a href="oauth2client.file.html">file</a><br>
|
||||
<a href="oauth2client.multistore_file.html">multistore_file</a><br>
|
||||
<a href="oauth2client.tools.html">tools</a><br>
|
||||
</td><td width="25%" valign=top></td></tr></table></td></tr></table>
|
||||
</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="#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>__version__</strong> = '1.0b9'</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="oauth2client.html"><font color="#ffffff">oauth2client</font></a>.multistore_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/multistore_file.py">/home/jcgregorio/projects/google-api-python-client/oauth2client/multistore_file.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient/oauth2client/multistore_file.py">/home/jcgregorio/projects/apiclient/oauth2client/multistore_file.py</a></font></td></tr></table>
|
||||
<p><tt>Multi-credential file store with lock support.<br>
|
||||
<br>
|
||||
This module implements a JSON credential store where multiple<br>
|
||||
|
||||
@@ -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:/home/jcgregorio/projects/apiclient/oauth2client/tools.py">/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:/home/jcgregorio/projects/apiclient/uritemplate/__init__.py">/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