Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b4169b5fff9e64688e4e3f4254624fbdcd00b25d / . / docs / oauth2client.django_orm.html
blob: 644c10ac4e8b57f47ff07186968765bfb0674f45 [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 Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]11><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient-release/oauth2client/django_orm.py">/home/jcgregorio/projects/apiclient-release/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 Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]65<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>
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]66
67<dl><dt><a name="CredentialsField-get_internal_type"><strong>get_internal_type</strong></a>(self)</dt></dl>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]68
69<dl><dt><a name="CredentialsField-to_python"><strong>to_python</strong></a>(self, value)</dt></dl>
70
71<hr>
72Data and other attributes defined here:<br>
73<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>
74has&nbsp;the&nbsp;descriptor&nbsp;protocol&nbsp;attached&nbsp;to&nbsp;it.</tt></dl>
75
76<hr>
77Methods inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
78<dl><dt><a name="CredentialsField-__cmp__"><strong>__cmp__</strong></a>(self, other)</dt></dl>
79
80<dl><dt><a name="CredentialsField-__deepcopy__"><strong>__deepcopy__</strong></a>(self, memodict)</dt></dl>
81
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]82<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>)</dt></dl>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]83
84<dl><dt><a name="CredentialsField-bind"><strong>bind</strong></a>(self, fieldmapping, original, bound_field_class)</dt></dl>
85
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]86<dl><dt><a name="CredentialsField-db_type"><strong>db_type</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;database&nbsp;column&nbsp;data&nbsp;type&nbsp;for&nbsp;this&nbsp;field,&nbsp;taking&nbsp;into<br>
87account&nbsp;the&nbsp;DATABASE_ENGINE&nbsp;setting.</tt></dd></dl>
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]88
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]89<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>
90
91<dl><dt><a name="CredentialsField-get_attname"><strong>get_attname</strong></a>(self)</dt></dl>
92
93<dl><dt><a name="CredentialsField-get_attname_column"><strong>get_attname_column</strong></a>(self)</dt></dl>
94
95<dl><dt><a name="CredentialsField-get_cache_name"><strong>get_cache_name</strong></a>(self)</dt></dl>
96
97<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>
98as&nbsp;SelectField&nbsp;choices&nbsp;for&nbsp;this&nbsp;field.</tt></dd></dl>
99
100<dl><dt><a name="CredentialsField-get_choices_default"><strong>get_choices_default</strong></a>(self)</dt></dl>
101
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]102<dl><dt><a name="CredentialsField-get_db_prep_lookup"><strong>get_db_prep_lookup</strong></a>(self, lookup_type, value)</dt><dd><tt>Returns&nbsp;field's&nbsp;value&nbsp;prepared&nbsp;for&nbsp;database&nbsp;lookup.</tt></dd></dl>
103
104<dl><dt><a name="CredentialsField-get_db_prep_save"><strong>get_db_prep_save</strong></a>(self, value)</dt><dd><tt>Returns&nbsp;field's&nbsp;value&nbsp;prepared&nbsp;for&nbsp;saving&nbsp;into&nbsp;a&nbsp;database.</tt></dd></dl>
105
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]106<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>
107
108<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>
109
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]110<dl><dt><a name="CredentialsField-get_validator_unique_lookup_type"><strong>get_validator_unique_lookup_type</strong></a>(self)</dt></dl>
111
112<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>
113
114<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>
115
116<dl><dt><a name="CredentialsField-save_form_data"><strong>save_form_data</strong></a>(self, instance, data)</dt></dl>
117
118<dl><dt><a name="CredentialsField-set_attributes_from_name"><strong>set_attributes_from_name</strong></a>(self, name)</dt></dl>
119
120<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>
121
122<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>
123This&nbsp;is&nbsp;used&nbsp;by&nbsp;the&nbsp;serialization&nbsp;framework.</tt></dd></dl>
124
125<hr>
126Data descriptors inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
127<dl><dt><strong>__dict__</strong></dt>
128<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
129</dl>
130<dl><dt><strong>__weakref__</strong></dt>
131<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
132</dl>
133<dl><dt><strong>choices</strong></dt>
134</dl>
135<dl><dt><strong>flatchoices</strong></dt>
136<dd><tt>Flattened&nbsp;version&nbsp;of&nbsp;choices&nbsp;tuple.</tt></dd>
137</dl>
138<dl><dt><strong>unique</strong></dt>
139</dl>
140<hr>
141Data and other attributes inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
142<dl><dt><strong>auto_creation_counter</strong> = -1</dl>
143
144<dl><dt><strong>creation_counter</strong> = 0</dl>
145
146<dl><dt><strong>empty_strings_allowed</strong> = True</dl>
147
148</td></tr></table> <p>
149<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
150<tr bgcolor="#ffc8d8">
151<td colspan=3 valign=bottom>&nbsp;<br>
152<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>
153
154<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
155<td width="100%"><dl><dt>Method resolution order:</dt>
156<dd><a href="oauth2client.django_orm.html#FlowField">FlowField</a></dd>
157<dd><a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a></dd>
158<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
159</dl>
160<hr>
161Methods defined here:<br>
162<dl><dt><a name="FlowField-contribute_to_class"><strong>contribute_to_class</strong></a>(self, cls, name)</dt></dl>
163
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]164<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>
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]165
166<dl><dt><a name="FlowField-get_internal_type"><strong>get_internal_type</strong></a>(self)</dt></dl>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]167
168<dl><dt><a name="FlowField-to_python"><strong>to_python</strong></a>(self, value)</dt></dl>
169
170<hr>
171Data and other attributes defined here:<br>
172<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>
173has&nbsp;the&nbsp;descriptor&nbsp;protocol&nbsp;attached&nbsp;to&nbsp;it.</tt></dl>
174
175<hr>
176Methods inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
177<dl><dt><a name="FlowField-__cmp__"><strong>__cmp__</strong></a>(self, other)</dt></dl>
178
179<dl><dt><a name="FlowField-__deepcopy__"><strong>__deepcopy__</strong></a>(self, memodict)</dt></dl>
180
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]181<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>)</dt></dl>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]182
183<dl><dt><a name="FlowField-bind"><strong>bind</strong></a>(self, fieldmapping, original, bound_field_class)</dt></dl>
184
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]185<dl><dt><a name="FlowField-db_type"><strong>db_type</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;database&nbsp;column&nbsp;data&nbsp;type&nbsp;for&nbsp;this&nbsp;field,&nbsp;taking&nbsp;into<br>
186account&nbsp;the&nbsp;DATABASE_ENGINE&nbsp;setting.</tt></dd></dl>
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]187
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]188<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>
189
190<dl><dt><a name="FlowField-get_attname"><strong>get_attname</strong></a>(self)</dt></dl>
191
192<dl><dt><a name="FlowField-get_attname_column"><strong>get_attname_column</strong></a>(self)</dt></dl>
193
194<dl><dt><a name="FlowField-get_cache_name"><strong>get_cache_name</strong></a>(self)</dt></dl>
195
196<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>
197as&nbsp;SelectField&nbsp;choices&nbsp;for&nbsp;this&nbsp;field.</tt></dd></dl>
198
199<dl><dt><a name="FlowField-get_choices_default"><strong>get_choices_default</strong></a>(self)</dt></dl>
200
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]201<dl><dt><a name="FlowField-get_db_prep_lookup"><strong>get_db_prep_lookup</strong></a>(self, lookup_type, value)</dt><dd><tt>Returns&nbsp;field's&nbsp;value&nbsp;prepared&nbsp;for&nbsp;database&nbsp;lookup.</tt></dd></dl>
202
203<dl><dt><a name="FlowField-get_db_prep_save"><strong>get_db_prep_save</strong></a>(self, value)</dt><dd><tt>Returns&nbsp;field's&nbsp;value&nbsp;prepared&nbsp;for&nbsp;saving&nbsp;into&nbsp;a&nbsp;database.</tt></dd></dl>
204
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]205<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>
206
207<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>
208
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]209<dl><dt><a name="FlowField-get_validator_unique_lookup_type"><strong>get_validator_unique_lookup_type</strong></a>(self)</dt></dl>
210
211<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>
212
213<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>
214
215<dl><dt><a name="FlowField-save_form_data"><strong>save_form_data</strong></a>(self, instance, data)</dt></dl>
216
217<dl><dt><a name="FlowField-set_attributes_from_name"><strong>set_attributes_from_name</strong></a>(self, name)</dt></dl>
218
219<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>
220
221<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>
222This&nbsp;is&nbsp;used&nbsp;by&nbsp;the&nbsp;serialization&nbsp;framework.</tt></dd></dl>
223
224<hr>
225Data descriptors inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
226<dl><dt><strong>__dict__</strong></dt>
227<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
228</dl>
229<dl><dt><strong>__weakref__</strong></dt>
230<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
231</dl>
232<dl><dt><strong>choices</strong></dt>
233</dl>
234<dl><dt><strong>flatchoices</strong></dt>
235<dd><tt>Flattened&nbsp;version&nbsp;of&nbsp;choices&nbsp;tuple.</tt></dd>
236</dl>
237<dl><dt><strong>unique</strong></dt>
238</dl>
239<hr>
240Data and other attributes inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
241<dl><dt><strong>auto_creation_counter</strong> = -1</dl>
242
243<dl><dt><strong>creation_counter</strong> = 0</dl>
244
245<dl><dt><strong>empty_strings_allowed</strong> = True</dl>
246
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]247</td></tr></table> <p>
248<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
249<tr bgcolor="#ffc8d8">
250<td colspan=3 valign=bottom>&nbsp;<br>
251<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>
252
253<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
254<td colspan=2><tt>Store&nbsp;and&nbsp;retrieve&nbsp;a&nbsp;single&nbsp;credential&nbsp;to&nbsp;and&nbsp;from<br>
255the&nbsp;datastore.<br>
256&nbsp;<br>
257This&nbsp;<a href="#Storage">Storage</a>&nbsp;helper&nbsp;presumes&nbsp;the&nbsp;Credentials<br>
258have&nbsp;been&nbsp;stored&nbsp;as&nbsp;a&nbsp;CredenialsField<br>
259on&nbsp;a&nbsp;db&nbsp;model&nbsp;class.<br>&nbsp;</tt></td></tr>
260<tr><td>&nbsp;</td>
261<td width="100%"><dl><dt>Method resolution order:</dt>
262<dd><a href="oauth2client.django_orm.html#Storage">Storage</a></dd>
263<dd><a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a></dd>
264<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
265</dl>
266<hr>
267Methods defined here:<br>
268<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>
269&nbsp;<br>
270Args:<br>
271&nbsp;&nbsp;model:&nbsp;db.Model,&nbsp;model&nbsp;class<br>
272&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>
273&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>
274&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>
275
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]276<dl><dt><a name="Storage-locked_get"><strong>locked_get</strong></a>(self)</dt><dd><tt>Retrieve&nbsp;Credential&nbsp;from&nbsp;datastore.<br>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]277&nbsp;<br>
278Returns:<br>
279&nbsp;&nbsp;oauth2client.Credentials</tt></dd></dl>
280
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]281<dl><dt><a name="Storage-locked_put"><strong>locked_put</strong></a>(self, credentials)</dt><dd><tt>Write&nbsp;a&nbsp;Credentials&nbsp;to&nbsp;the&nbsp;datastore.<br>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]282&nbsp;<br>
283Args:<br>
284&nbsp;&nbsp;credentials:&nbsp;Credentials,&nbsp;the&nbsp;credentials&nbsp;to&nbsp;store.</tt></dd></dl>
285
286<hr>
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]287Methods inherited from <a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>:<br>
288<dl><dt><a name="Storage-acquire_lock"><strong>acquire_lock</strong></a>(self)</dt><dd><tt>Acquires&nbsp;any&nbsp;lock&nbsp;necessary&nbsp;to&nbsp;access&nbsp;this&nbsp;<a href="#Storage">Storage</a>.<br>
289&nbsp;<br>
290This&nbsp;lock&nbsp;is&nbsp;not&nbsp;reentrant.</tt></dd></dl>
291
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]292<dl><dt><a name="Storage-get"><strong>get</strong></a>(self)</dt><dd><tt>Retrieve&nbsp;credential.<br>
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]293&nbsp;<br>
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]294The&nbsp;<a href="#Storage">Storage</a>&nbsp;lock&nbsp;must&nbsp;*not*&nbsp;be&nbsp;held&nbsp;when&nbsp;this&nbsp;is&nbsp;called.<br>
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]295&nbsp;<br>
296Returns:<br>
297&nbsp;&nbsp;oauth2client.client.Credentials</tt></dd></dl>
298
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]299<dl><dt><a name="Storage-put"><strong>put</strong></a>(self, credentials)</dt><dd><tt>Write&nbsp;a&nbsp;credential.<br>
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]300&nbsp;<br>
301The&nbsp;<a href="#Storage">Storage</a>&nbsp;lock&nbsp;must&nbsp;be&nbsp;held&nbsp;when&nbsp;this&nbsp;is&nbsp;called.<br>
302&nbsp;<br>
303Args:<br>
304&nbsp;&nbsp;credentials:&nbsp;Credentials,&nbsp;the&nbsp;credentials&nbsp;to&nbsp;store.</tt></dd></dl>
305
306<dl><dt><a name="Storage-release_lock"><strong>release_lock</strong></a>(self)</dt><dd><tt>Release&nbsp;the&nbsp;<a href="#Storage">Storage</a>&nbsp;lock.<br>
307&nbsp;<br>
308Trying&nbsp;to&nbsp;release&nbsp;a&nbsp;lock&nbsp;that&nbsp;isn't&nbsp;held&nbsp;will&nbsp;result&nbsp;in&nbsp;a<br>
309RuntimeError.</tt></dd></dl>
310
311<hr>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]312Data descriptors inherited from <a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>:<br>
313<dl><dt><strong>__dict__</strong></dt>
314<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
315</dl>
316<dl><dt><strong>__weakref__</strong></dt>
317<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
318</dl>
319</td></tr></table></td></tr></table><p>
320<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
321<tr bgcolor="#55aa55">
322<td colspan=3 valign=bottom>&nbsp;<br>
323<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
324
325<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
326<td width="100%"><strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p>
327<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
328<tr bgcolor="#7799ee">
329<td colspan=3 valign=bottom>&nbsp;<br>
330<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
331
332<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
333<td width="100%">jcgregorio@google.com&nbsp;(Joe&nbsp;Gregorio)</td></tr></table>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]334</body></html>