Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 351b149b14d2dd7f356c56e3344015aba92e46f5 / . / docs / oauth2client.django_orm.html
blob: cfcd431eb0a127d4997a0ba725899d3e3fc3c71e [file] [log] [blame]
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module oauth2client.django_orm</title>
4</head><body bgcolor="#f0f0f8">
5
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
7<tr bgcolor="#7799ee">
8<td valign=bottom>&nbsp;<br>
9<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="oauth2client.html"><font color="#ffffff">oauth2client</font></a>.django_orm</strong></big></big></font></td
10><td align=right valign=bottom
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame^]11><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/oauth2client/django_orm.py">/home/jcgregorio/projects/google-api-python-client/oauth2client/django_orm.py</a></font></td></tr></table>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]12 <p><tt>OAuth&nbsp;2.0&nbsp;utilities&nbsp;for&nbsp;Django.<br>
13&nbsp;<br>
14Utilities&nbsp;for&nbsp;using&nbsp;OAuth&nbsp;2.0&nbsp;in&nbsp;conjunction&nbsp;with<br>
15the&nbsp;Django&nbsp;datastore.</tt></p>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]16<p>
17<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
18<tr bgcolor="#aa55cc">
19<td colspan=3 valign=bottom>&nbsp;<br>
20<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
21
22<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]23<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="base64.html">base64</a><br>
24</td><td width="25%" valign=top><a href="django.db.models.html">django.db.models</a><br>
25</td><td width="25%" valign=top><a href="oauth2client.html">oauth2client</a><br>
26</td><td width="25%" valign=top><a href="pickle.html">pickle</a><br>
27</td></tr></table></td></tr></table><p>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]28<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
29<tr bgcolor="#ee77aa">
30<td colspan=3 valign=bottom>&nbsp;<br>
31<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
32
33<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
34<td width="100%"><dl>
35<dt><font face="helvetica, arial"><a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
36</font></dt><dd>
37<dl>
38<dt><font face="helvetica, arial"><a href="oauth2client.django_orm.html#CredentialsField">CredentialsField</a>
39</font></dt><dt><font face="helvetica, arial"><a href="oauth2client.django_orm.html#FlowField">FlowField</a>
40</font></dt></dl>
41</dd>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]42<dt><font face="helvetica, arial"><a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
43</font></dt><dd>
44<dl>
45<dt><font face="helvetica, arial"><a href="oauth2client.django_orm.html#Storage">Storage</a>
46</font></dt></dl>
47</dd>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]48</dl>
49 <p>
50<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
51<tr bgcolor="#ffc8d8">
52<td colspan=3 valign=bottom>&nbsp;<br>
53<font color="#000000" face="helvetica, arial"><a name="CredentialsField">class <strong>CredentialsField</strong></a>(<a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>)</font></td></tr>
54
55<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
56<td width="100%"><dl><dt>Method resolution order:</dt>
57<dd><a href="oauth2client.django_orm.html#CredentialsField">CredentialsField</a></dd>
58<dd><a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a></dd>
59<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
60</dl>
61<hr>
62Methods defined here:<br>
63<dl><dt><a name="CredentialsField-contribute_to_class"><strong>contribute_to_class</strong></a>(self, cls, name)</dt></dl>
64
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]65<dl><dt><a name="CredentialsField-db_type"><strong>db_type</strong></a> = inner(*args, **kwargs)</dt></dl>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]66
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]67<dl><dt><a name="CredentialsField-get_db_prep_lookup"><strong>get_db_prep_lookup</strong></a> = inner(*args, **kwargs)</dt></dl>
68
69<dl><dt><a name="CredentialsField-get_db_prep_save"><strong>get_db_prep_save</strong></a> = inner(*args, **kwargs)</dt></dl>
70
71<dl><dt><a name="CredentialsField-get_db_prep_value"><strong>get_db_prep_value</strong></a> = inner(*args, **kwargs)</dt></dl>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]72
73<dl><dt><a name="CredentialsField-to_python"><strong>to_python</strong></a>(self, value)</dt></dl>
74
75<hr>
76Data and other attributes defined here:<br>
77<dl><dt><strong>__metaclass__</strong> = &lt;class 'django.db.models.fields.subclassing.SubfieldBase'&gt;<dd><tt>A&nbsp;metaclass&nbsp;for&nbsp;custom&nbsp;<a href="django.db.models.fields.html#Field">Field</a>&nbsp;subclasses.&nbsp;This&nbsp;ensures&nbsp;the&nbsp;model's&nbsp;attribute<br>
78has&nbsp;the&nbsp;descriptor&nbsp;protocol&nbsp;attached&nbsp;to&nbsp;it.</tt></dl>
79
80<hr>
81Methods inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
82<dl><dt><a name="CredentialsField-__cmp__"><strong>__cmp__</strong></a>(self, other)</dt></dl>
83
84<dl><dt><a name="CredentialsField-__deepcopy__"><strong>__deepcopy__</strong></a>(self, memodict)</dt></dl>
85
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]86<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">=&lt;class django.db.models.fields.NOT_PROVIDED&gt;</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>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]87
88<dl><dt><a name="CredentialsField-bind"><strong>bind</strong></a>(self, fieldmapping, original, bound_field_class)</dt></dl>
89
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]90<dl><dt><a name="CredentialsField-clean"><strong>clean</strong></a>(self, value, model_instance)</dt><dd><tt>Convert&nbsp;the&nbsp;value's&nbsp;type&nbsp;and&nbsp;run&nbsp;validation.&nbsp;Validation&nbsp;errors&nbsp;from&nbsp;to_python<br>
91and&nbsp;validate&nbsp;are&nbsp;propagated.&nbsp;The&nbsp;correct&nbsp;value&nbsp;is&nbsp;returned&nbsp;if&nbsp;no&nbsp;error&nbsp;is<br>
92raised.</tt></dd></dl>
93
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]94<dl><dt><a name="CredentialsField-formfield"><strong>formfield</strong></a>(self, form_class<font color="#909090">=&lt;class 'django.forms.fields.CharField'&gt;</font>, **kwargs)</dt><dd><tt>Returns&nbsp;a&nbsp;django.forms.<a href="django.db.models.fields.html#Field">Field</a>&nbsp;instance&nbsp;for&nbsp;this&nbsp;database&nbsp;<a href="django.db.models.fields.html#Field">Field</a>.</tt></dd></dl>
95
96<dl><dt><a name="CredentialsField-get_attname"><strong>get_attname</strong></a>(self)</dt></dl>
97
98<dl><dt><a name="CredentialsField-get_attname_column"><strong>get_attname_column</strong></a>(self)</dt></dl>
99
100<dl><dt><a name="CredentialsField-get_cache_name"><strong>get_cache_name</strong></a>(self)</dt></dl>
101
102<dl><dt><a name="CredentialsField-get_choices"><strong>get_choices</strong></a>(self, include_blank<font color="#909090">=True</font>, blank_choice<font color="#909090">=[('', '---------')]</font>)</dt><dd><tt>Returns&nbsp;choices&nbsp;with&nbsp;a&nbsp;default&nbsp;blank&nbsp;choices&nbsp;included,&nbsp;for&nbsp;use<br>
103as&nbsp;SelectField&nbsp;choices&nbsp;for&nbsp;this&nbsp;field.</tt></dd></dl>
104
105<dl><dt><a name="CredentialsField-get_choices_default"><strong>get_choices_default</strong></a>(self)</dt></dl>
106
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]107<dl><dt><a name="CredentialsField-get_default"><strong>get_default</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;default&nbsp;value&nbsp;for&nbsp;this&nbsp;field.</tt></dd></dl>
108
109<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&nbsp;flattened&nbsp;choices&nbsp;with&nbsp;a&nbsp;default&nbsp;blank&nbsp;choice&nbsp;included.</tt></dd></dl>
110
111<dl><dt><a name="CredentialsField-get_internal_type"><strong>get_internal_type</strong></a>(self)</dt></dl>
112
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]113<dl><dt><a name="CredentialsField-get_prep_lookup"><strong>get_prep_lookup</strong></a>(self, lookup_type, value)</dt><dd><tt>Perform&nbsp;preliminary&nbsp;non-db&nbsp;specific&nbsp;lookup&nbsp;checks&nbsp;and&nbsp;conversions</tt></dd></dl>
114
115<dl><dt><a name="CredentialsField-get_prep_value"><strong>get_prep_value</strong></a>(self, value)</dt><dd><tt>Perform&nbsp;preliminary&nbsp;non-db&nbsp;specific&nbsp;value&nbsp;checks&nbsp;and&nbsp;conversions.</tt></dd></dl>
116
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]117<dl><dt><a name="CredentialsField-get_validator_unique_lookup_type"><strong>get_validator_unique_lookup_type</strong></a>(self)</dt></dl>
118
119<dl><dt><a name="CredentialsField-has_default"><strong>has_default</strong></a>(self)</dt><dd><tt>Returns&nbsp;a&nbsp;boolean&nbsp;of&nbsp;whether&nbsp;this&nbsp;field&nbsp;has&nbsp;a&nbsp;default&nbsp;value.</tt></dd></dl>
120
121<dl><dt><a name="CredentialsField-pre_save"><strong>pre_save</strong></a>(self, model_instance, add)</dt><dd><tt>Returns&nbsp;field's&nbsp;value&nbsp;just&nbsp;before&nbsp;saving.</tt></dd></dl>
122
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]123<dl><dt><a name="CredentialsField-run_validators"><strong>run_validators</strong></a>(self, value)</dt></dl>
124
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]125<dl><dt><a name="CredentialsField-save_form_data"><strong>save_form_data</strong></a>(self, instance, data)</dt></dl>
126
127<dl><dt><a name="CredentialsField-set_attributes_from_name"><strong>set_attributes_from_name</strong></a>(self, name)</dt></dl>
128
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]129<dl><dt><a name="CredentialsField-validate"><strong>validate</strong></a>(self, value, model_instance)</dt><dd><tt>Validates&nbsp;value&nbsp;and&nbsp;throws&nbsp;ValidationError.&nbsp;Subclasses&nbsp;should&nbsp;override<br>
130this&nbsp;to&nbsp;provide&nbsp;validation&nbsp;logic.</tt></dd></dl>
131
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]132<dl><dt><a name="CredentialsField-value_from_object"><strong>value_from_object</strong></a>(self, obj)</dt><dd><tt>Returns&nbsp;the&nbsp;value&nbsp;of&nbsp;this&nbsp;field&nbsp;in&nbsp;the&nbsp;given&nbsp;model&nbsp;instance.</tt></dd></dl>
133
134<dl><dt><a name="CredentialsField-value_to_string"><strong>value_to_string</strong></a>(self, obj)</dt><dd><tt>Returns&nbsp;a&nbsp;string&nbsp;value&nbsp;of&nbsp;this&nbsp;field&nbsp;from&nbsp;the&nbsp;passed&nbsp;obj.<br>
135This&nbsp;is&nbsp;used&nbsp;by&nbsp;the&nbsp;serialization&nbsp;framework.</tt></dd></dl>
136
137<hr>
138Data descriptors inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
139<dl><dt><strong>__dict__</strong></dt>
140<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
141</dl>
142<dl><dt><strong>__weakref__</strong></dt>
143<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
144</dl>
145<dl><dt><strong>choices</strong></dt>
146</dl>
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]147<dl><dt><strong>description</strong></dt>
148</dl>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]149<dl><dt><strong>flatchoices</strong></dt>
150<dd><tt>Flattened&nbsp;version&nbsp;of&nbsp;choices&nbsp;tuple.</tt></dd>
151</dl>
152<dl><dt><strong>unique</strong></dt>
153</dl>
154<hr>
155Data and other attributes inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
156<dl><dt><strong>auto_creation_counter</strong> = -1</dl>
157
158<dl><dt><strong>creation_counter</strong> = 0</dl>
159
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]160<dl><dt><strong>default_error_messages</strong> = {'blank': &lt;django.utils.functional.__proxy__ object&gt;, 'invalid_choice': &lt;django.utils.functional.__proxy__ object&gt;, 'null': &lt;django.utils.functional.__proxy__ object&gt;}</dl>
161
162<dl><dt><strong>default_validators</strong> = []</dl>
163
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]164<dl><dt><strong>empty_strings_allowed</strong> = True</dl>
165
166</td></tr></table> <p>
167<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
168<tr bgcolor="#ffc8d8">
169<td colspan=3 valign=bottom>&nbsp;<br>
170<font color="#000000" face="helvetica, arial"><a name="FlowField">class <strong>FlowField</strong></a>(<a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>)</font></td></tr>
171
172<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
173<td width="100%"><dl><dt>Method resolution order:</dt>
174<dd><a href="oauth2client.django_orm.html#FlowField">FlowField</a></dd>
175<dd><a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a></dd>
176<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
177</dl>
178<hr>
179Methods defined here:<br>
180<dl><dt><a name="FlowField-contribute_to_class"><strong>contribute_to_class</strong></a>(self, cls, name)</dt></dl>
181
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]182<dl><dt><a name="FlowField-db_type"><strong>db_type</strong></a> = inner(*args, **kwargs)</dt></dl>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]183
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]184<dl><dt><a name="FlowField-get_db_prep_lookup"><strong>get_db_prep_lookup</strong></a> = inner(*args, **kwargs)</dt></dl>
185
186<dl><dt><a name="FlowField-get_db_prep_save"><strong>get_db_prep_save</strong></a> = inner(*args, **kwargs)</dt></dl>
187
188<dl><dt><a name="FlowField-get_db_prep_value"><strong>get_db_prep_value</strong></a> = inner(*args, **kwargs)</dt></dl>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]189
190<dl><dt><a name="FlowField-to_python"><strong>to_python</strong></a>(self, value)</dt></dl>
191
192<hr>
193Data and other attributes defined here:<br>
194<dl><dt><strong>__metaclass__</strong> = &lt;class 'django.db.models.fields.subclassing.SubfieldBase'&gt;<dd><tt>A&nbsp;metaclass&nbsp;for&nbsp;custom&nbsp;<a href="django.db.models.fields.html#Field">Field</a>&nbsp;subclasses.&nbsp;This&nbsp;ensures&nbsp;the&nbsp;model's&nbsp;attribute<br>
195has&nbsp;the&nbsp;descriptor&nbsp;protocol&nbsp;attached&nbsp;to&nbsp;it.</tt></dl>
196
197<hr>
198Methods inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
199<dl><dt><a name="FlowField-__cmp__"><strong>__cmp__</strong></a>(self, other)</dt></dl>
200
201<dl><dt><a name="FlowField-__deepcopy__"><strong>__deepcopy__</strong></a>(self, memodict)</dt></dl>
202
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]203<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">=&lt;class django.db.models.fields.NOT_PROVIDED&gt;</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>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]204
205<dl><dt><a name="FlowField-bind"><strong>bind</strong></a>(self, fieldmapping, original, bound_field_class)</dt></dl>
206
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]207<dl><dt><a name="FlowField-clean"><strong>clean</strong></a>(self, value, model_instance)</dt><dd><tt>Convert&nbsp;the&nbsp;value's&nbsp;type&nbsp;and&nbsp;run&nbsp;validation.&nbsp;Validation&nbsp;errors&nbsp;from&nbsp;to_python<br>
208and&nbsp;validate&nbsp;are&nbsp;propagated.&nbsp;The&nbsp;correct&nbsp;value&nbsp;is&nbsp;returned&nbsp;if&nbsp;no&nbsp;error&nbsp;is<br>
209raised.</tt></dd></dl>
210
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]211<dl><dt><a name="FlowField-formfield"><strong>formfield</strong></a>(self, form_class<font color="#909090">=&lt;class 'django.forms.fields.CharField'&gt;</font>, **kwargs)</dt><dd><tt>Returns&nbsp;a&nbsp;django.forms.<a href="django.db.models.fields.html#Field">Field</a>&nbsp;instance&nbsp;for&nbsp;this&nbsp;database&nbsp;<a href="django.db.models.fields.html#Field">Field</a>.</tt></dd></dl>
212
213<dl><dt><a name="FlowField-get_attname"><strong>get_attname</strong></a>(self)</dt></dl>
214
215<dl><dt><a name="FlowField-get_attname_column"><strong>get_attname_column</strong></a>(self)</dt></dl>
216
217<dl><dt><a name="FlowField-get_cache_name"><strong>get_cache_name</strong></a>(self)</dt></dl>
218
219<dl><dt><a name="FlowField-get_choices"><strong>get_choices</strong></a>(self, include_blank<font color="#909090">=True</font>, blank_choice<font color="#909090">=[('', '---------')]</font>)</dt><dd><tt>Returns&nbsp;choices&nbsp;with&nbsp;a&nbsp;default&nbsp;blank&nbsp;choices&nbsp;included,&nbsp;for&nbsp;use<br>
220as&nbsp;SelectField&nbsp;choices&nbsp;for&nbsp;this&nbsp;field.</tt></dd></dl>
221
222<dl><dt><a name="FlowField-get_choices_default"><strong>get_choices_default</strong></a>(self)</dt></dl>
223
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]224<dl><dt><a name="FlowField-get_default"><strong>get_default</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;default&nbsp;value&nbsp;for&nbsp;this&nbsp;field.</tt></dd></dl>
225
226<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&nbsp;flattened&nbsp;choices&nbsp;with&nbsp;a&nbsp;default&nbsp;blank&nbsp;choice&nbsp;included.</tt></dd></dl>
227
228<dl><dt><a name="FlowField-get_internal_type"><strong>get_internal_type</strong></a>(self)</dt></dl>
229
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]230<dl><dt><a name="FlowField-get_prep_lookup"><strong>get_prep_lookup</strong></a>(self, lookup_type, value)</dt><dd><tt>Perform&nbsp;preliminary&nbsp;non-db&nbsp;specific&nbsp;lookup&nbsp;checks&nbsp;and&nbsp;conversions</tt></dd></dl>
231
232<dl><dt><a name="FlowField-get_prep_value"><strong>get_prep_value</strong></a>(self, value)</dt><dd><tt>Perform&nbsp;preliminary&nbsp;non-db&nbsp;specific&nbsp;value&nbsp;checks&nbsp;and&nbsp;conversions.</tt></dd></dl>
233
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]234<dl><dt><a name="FlowField-get_validator_unique_lookup_type"><strong>get_validator_unique_lookup_type</strong></a>(self)</dt></dl>
235
236<dl><dt><a name="FlowField-has_default"><strong>has_default</strong></a>(self)</dt><dd><tt>Returns&nbsp;a&nbsp;boolean&nbsp;of&nbsp;whether&nbsp;this&nbsp;field&nbsp;has&nbsp;a&nbsp;default&nbsp;value.</tt></dd></dl>
237
238<dl><dt><a name="FlowField-pre_save"><strong>pre_save</strong></a>(self, model_instance, add)</dt><dd><tt>Returns&nbsp;field's&nbsp;value&nbsp;just&nbsp;before&nbsp;saving.</tt></dd></dl>
239
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]240<dl><dt><a name="FlowField-run_validators"><strong>run_validators</strong></a>(self, value)</dt></dl>
241
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]242<dl><dt><a name="FlowField-save_form_data"><strong>save_form_data</strong></a>(self, instance, data)</dt></dl>
243
244<dl><dt><a name="FlowField-set_attributes_from_name"><strong>set_attributes_from_name</strong></a>(self, name)</dt></dl>
245
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]246<dl><dt><a name="FlowField-validate"><strong>validate</strong></a>(self, value, model_instance)</dt><dd><tt>Validates&nbsp;value&nbsp;and&nbsp;throws&nbsp;ValidationError.&nbsp;Subclasses&nbsp;should&nbsp;override<br>
247this&nbsp;to&nbsp;provide&nbsp;validation&nbsp;logic.</tt></dd></dl>
248
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]249<dl><dt><a name="FlowField-value_from_object"><strong>value_from_object</strong></a>(self, obj)</dt><dd><tt>Returns&nbsp;the&nbsp;value&nbsp;of&nbsp;this&nbsp;field&nbsp;in&nbsp;the&nbsp;given&nbsp;model&nbsp;instance.</tt></dd></dl>
250
251<dl><dt><a name="FlowField-value_to_string"><strong>value_to_string</strong></a>(self, obj)</dt><dd><tt>Returns&nbsp;a&nbsp;string&nbsp;value&nbsp;of&nbsp;this&nbsp;field&nbsp;from&nbsp;the&nbsp;passed&nbsp;obj.<br>
252This&nbsp;is&nbsp;used&nbsp;by&nbsp;the&nbsp;serialization&nbsp;framework.</tt></dd></dl>
253
254<hr>
255Data descriptors inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
256<dl><dt><strong>__dict__</strong></dt>
257<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
258</dl>
259<dl><dt><strong>__weakref__</strong></dt>
260<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
261</dl>
262<dl><dt><strong>choices</strong></dt>
263</dl>
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]264<dl><dt><strong>description</strong></dt>
265</dl>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]266<dl><dt><strong>flatchoices</strong></dt>
267<dd><tt>Flattened&nbsp;version&nbsp;of&nbsp;choices&nbsp;tuple.</tt></dd>
268</dl>
269<dl><dt><strong>unique</strong></dt>
270</dl>
271<hr>
272Data and other attributes inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
273<dl><dt><strong>auto_creation_counter</strong> = -1</dl>
274
275<dl><dt><strong>creation_counter</strong> = 0</dl>
276
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]277<dl><dt><strong>default_error_messages</strong> = {'blank': &lt;django.utils.functional.__proxy__ object&gt;, 'invalid_choice': &lt;django.utils.functional.__proxy__ object&gt;, 'null': &lt;django.utils.functional.__proxy__ object&gt;}</dl>
278
279<dl><dt><strong>default_validators</strong> = []</dl>
280
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]281<dl><dt><strong>empty_strings_allowed</strong> = True</dl>
282
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]283</td></tr></table> <p>
284<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
285<tr bgcolor="#ffc8d8">
286<td colspan=3 valign=bottom>&nbsp;<br>
287<font color="#000000" face="helvetica, arial"><a name="Storage">class <strong>Storage</strong></a>(<a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>)</font></td></tr>
288
289<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
290<td colspan=2><tt>Store&nbsp;and&nbsp;retrieve&nbsp;a&nbsp;single&nbsp;credential&nbsp;to&nbsp;and&nbsp;from<br>
291the&nbsp;datastore.<br>
292&nbsp;<br>
293This&nbsp;<a href="#Storage">Storage</a>&nbsp;helper&nbsp;presumes&nbsp;the&nbsp;Credentials<br>
294have&nbsp;been&nbsp;stored&nbsp;as&nbsp;a&nbsp;CredenialsField<br>
295on&nbsp;a&nbsp;db&nbsp;model&nbsp;class.<br>&nbsp;</tt></td></tr>
296<tr><td>&nbsp;</td>
297<td width="100%"><dl><dt>Method resolution order:</dt>
298<dd><a href="oauth2client.django_orm.html#Storage">Storage</a></dd>
299<dd><a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a></dd>
300<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
301</dl>
302<hr>
303Methods defined here:<br>
304<dl><dt><a name="Storage-__init__"><strong>__init__</strong></a>(self, model_class, key_name, key_value, property_name)</dt><dd><tt>Constructor&nbsp;for&nbsp;<a href="#Storage">Storage</a>.<br>
305&nbsp;<br>
306Args:<br>
307&nbsp;&nbsp;model:&nbsp;db.Model,&nbsp;model&nbsp;class<br>
308&nbsp;&nbsp;key_name:&nbsp;string,&nbsp;key&nbsp;name&nbsp;for&nbsp;the&nbsp;entity&nbsp;that&nbsp;has&nbsp;the&nbsp;credentials<br>
309&nbsp;&nbsp;key_value:&nbsp;string,&nbsp;key&nbsp;value&nbsp;for&nbsp;the&nbsp;entity&nbsp;that&nbsp;has&nbsp;the&nbsp;credentials<br>
310&nbsp;&nbsp;property_name:&nbsp;string,&nbsp;name&nbsp;of&nbsp;the&nbsp;property&nbsp;that&nbsp;is&nbsp;an&nbsp;CredentialsProperty</tt></dd></dl>
311
312<dl><dt><a name="Storage-get"><strong>get</strong></a>(self)</dt><dd><tt>Retrieve&nbsp;Credential&nbsp;from&nbsp;datastore.<br>
313&nbsp;<br>
314Returns:<br>
315&nbsp;&nbsp;oauth2client.Credentials</tt></dd></dl>
316
317<dl><dt><a name="Storage-put"><strong>put</strong></a>(self, credentials)</dt><dd><tt>Write&nbsp;a&nbsp;Credentials&nbsp;to&nbsp;the&nbsp;datastore.<br>
318&nbsp;<br>
319Args:<br>
320&nbsp;&nbsp;credentials:&nbsp;Credentials,&nbsp;the&nbsp;credentials&nbsp;to&nbsp;store.</tt></dd></dl>
321
322<hr>
323Data descriptors inherited from <a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>:<br>
324<dl><dt><strong>__dict__</strong></dt>
325<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
326</dl>
327<dl><dt><strong>__weakref__</strong></dt>
328<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
329</dl>
330</td></tr></table></td></tr></table><p>
331<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
332<tr bgcolor="#55aa55">
333<td colspan=3 valign=bottom>&nbsp;<br>
334<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
335
336<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
337<td width="100%"><strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p>
338<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
339<tr bgcolor="#7799ee">
340<td colspan=3 valign=bottom>&nbsp;<br>
341<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
342
343<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
344<td width="100%">jcgregorio@google.com&nbsp;(Joe&nbsp;Gregorio)</td></tr></table>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]345</body></html>