Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 44454e4c65dda5a2a811553e1cc540140c039fd5 / . / docs / epy / oauth2client.appengine.CredentialsProperty-class.html
blob: 006b489e576927584381f5d6bab0b0527c7139d4 [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>oauth2client.appengine.CredentialsProperty</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32</table>
33<table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 <a href="oauth2client-module.html">Package&nbsp;oauth2client</a> ::
38 <a href="oauth2client.appengine-module.html">Module&nbsp;appengine</a> ::
39 Class&nbsp;CredentialsProperty
40 </span>
41 </td>
42 <td>
43 <table cellpadding="0" cellspacing="0">
44 <!-- hide/show private -->
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47 <tr><td align="right"><span class="options"
48 >[<a href="frames.html" target="_top">frames</a
49 >]&nbsp;|&nbsp;<a href="oauth2client.appengine.CredentialsProperty-class.html"
50 target="_top">no&nbsp;frames</a>]</span></td></tr>
51 </table>
52 </td>
53 </tr>
54</table>
55<!-- ==================== CLASS DESCRIPTION ==================== -->
56<h1 class="epydoc">Class CredentialsProperty</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsProperty">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="uml_class_diagram_for_oauth2cl_3" name="uml_class_diagram_for_oauth2cl_3">
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]59<area shape="rect" href="oauth2client.client.Credentials-class.html" title="Base class for all Credentials objects." alt="" coords="249,265,519,284"/>
60<area shape="rect" href="oauth2client.appengine.CredentialsProperty-class.html#get_value_for_datastore" title="Datastore representation of this property." alt="" coords="249,287,519,305"/>
61<area shape="rect" href="oauth2client.appengine.CredentialsProperty-class.html#make_value_from_datastore" title="Native representation of this property." alt="" coords="249,305,519,324"/>
62<area shape="rect" href="oauth2client.appengine.CredentialsProperty-class.html#validate" title="Assert that provided value is compatible with this property." alt="" coords="249,324,519,343"/>
63<area shape="rect" href="oauth2client.appengine.CredentialsProperty-class.html" title="App Engine datastore Property for Credentials." alt="" coords="248,248,520,344"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]64<area shape="rect" href="javascript:void(0);" title="google.appengine.ext.db.Property.creation_counter" alt="" coords="17,28,751,47"/>
65<area shape="rect" href="javascript:void(0);" title="Initializes this Property with the given options." alt="" coords="17,49,751,68"/>
66<area shape="rect" href="javascript:void(0);" title="Configure property, connecting it to its model." alt="" coords="17,68,751,87"/>
67<area shape="rect" href="javascript:void(0);" title="Returns the value for this property on the given model instance." alt="" coords="17,87,751,105"/>
68<area shape="rect" href="javascript:void(0);" title="Sets the value for this property on the given model instance." alt="" coords="17,105,751,124"/>
69<area shape="rect" href="javascript:void(0);" title="Default value for unassigned values." alt="" coords="17,124,751,143"/>
70<area shape="rect" href="javascript:void(0);" title="Determine if value is empty in the context of this property." alt="" coords="17,143,751,161"/>
71<area shape="rect" href="javascript:void(0);" title="Determine new value for auto&#45;updated property." alt="" coords="17,161,751,180"/>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]72<area shape="rect" href="javascript:void(0);" title="google.appengine.ext.db.Property.make_value_from_datastore_index_value" alt="" coords="17,180,751,199"/>
73<area shape="rect" href="javascript:void(0);" title="Deprecated backwards&#45;compatible accessor method for self.data_type." alt="" coords="17,199,751,217"/>
74<area shape="rect" href="javascript:void(0);" title="A Property is an attribute of a Model." alt="" coords="16,11,752,219"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]75</map>
76 <img src="uml_class_diagram_for_oauth2cl_3.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_3" ismap="ismap" class="graph-without-title" />
77</center>
78</center>
79<hr />
80<pre class="literalblock">
81App Engine datastore Property for Credentials.
82
83Utility property that allows easy storage and retrieval of
84oath2client.Credentials
85
86</pre>
87
88<!-- ==================== NESTED CLASSES ==================== -->
89<a name="section-NestedClasses"></a>
90<table class="summary" border="1" cellpadding="3"
91 cellspacing="0" width="100%" bgcolor="white">
92<tr bgcolor="#70b0f0" class="table-header">
93 <td colspan="2" class="table-header">
94 <table border="0" cellpadding="0" cellspacing="0" width="100%">
95 <tr valign="top">
96 <td align="left"><span class="table-header">Nested Classes</span></td>
97 <td align="right" valign="top"
98 ><span class="options">[<a href="#section-NestedClasses"
99 class="privatelink" onclick="toggle_private();"
100 >hide private</a>]</span></td>
101 </tr>
102 </table>
103 </td>
104</tr>
105<tr>
106 <td width="15%" align="right" valign="top" class="summary">
107 <span class="summary-type">&nbsp;</span>
108 </td><td class="summary">
109 <a href="oauth2client.client.Credentials-class.html" class="summary-name">data_type</a><br />
110 Base class for all Credentials objects.
111 </td>
112 </tr>
113</table>
114<!-- ==================== INSTANCE METHODS ==================== -->
115<a name="section-InstanceMethods"></a>
116<table class="summary" border="1" cellpadding="3"
117 cellspacing="0" width="100%" bgcolor="white">
118<tr bgcolor="#70b0f0" class="table-header">
119 <td colspan="2" class="table-header">
120 <table border="0" cellpadding="0" cellspacing="0" width="100%">
121 <tr valign="top">
122 <td align="left"><span class="table-header">Instance Methods</span></td>
123 <td align="right" valign="top"
124 ><span class="options">[<a href="#section-InstanceMethods"
125 class="privatelink" onclick="toggle_private();"
126 >hide private</a>]</span></td>
127 </tr>
128 </table>
129 </td>
130</tr>
131<tr>
132 <td width="15%" align="right" valign="top" class="summary">
133 <span class="summary-type">&nbsp;</span>
134 </td><td class="summary">
135 <table width="100%" cellpadding="0" cellspacing="0" border="0">
136 <tr>
137 <td><span class="summary-sig"><a href="oauth2client.appengine.CredentialsProperty-class.html#get_value_for_datastore" class="summary-sig-name">get_value_for_datastore</a>(<span class="summary-sig-arg">self</span>,
138 <span class="summary-sig-arg">model_instance</span>)</span><br />
139 Datastore representation of this property.</td>
140 <td align="right" valign="top">
141 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsProperty.get_value_for_datastore">source&nbsp;code</a></span>
142
143 </td>
144 </tr>
145 </table>
146
147 </td>
148 </tr>
149<tr>
150 <td width="15%" align="right" valign="top" class="summary">
151 <span class="summary-type">&nbsp;</span>
152 </td><td class="summary">
153 <table width="100%" cellpadding="0" cellspacing="0" border="0">
154 <tr>
155 <td><span class="summary-sig"><a href="oauth2client.appengine.CredentialsProperty-class.html#make_value_from_datastore" class="summary-sig-name">make_value_from_datastore</a>(<span class="summary-sig-arg">self</span>,
156 <span class="summary-sig-arg">value</span>)</span><br />
157 Native representation of this property.</td>
158 <td align="right" valign="top">
159 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsProperty.make_value_from_datastore">source&nbsp;code</a></span>
160
161 </td>
162 </tr>
163 </table>
164
165 </td>
166 </tr>
167<tr>
168 <td width="15%" align="right" valign="top" class="summary">
169 <span class="summary-type">&nbsp;</span>
170 </td><td class="summary">
171 <table width="100%" cellpadding="0" cellspacing="0" border="0">
172 <tr>
173 <td><span class="summary-sig"><a href="oauth2client.appengine.CredentialsProperty-class.html#validate" class="summary-sig-name">validate</a>(<span class="summary-sig-arg">self</span>,
174 <span class="summary-sig-arg">value</span>)</span><br />
175 Assert that provided value is compatible with this property.</td>
176 <td align="right" valign="top">
177 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsProperty.validate">source&nbsp;code</a></span>
178
179 </td>
180 </tr>
181 </table>
182
183 </td>
184 </tr>
185 <tr>
186 <td colspan="2" class="summary">
187 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Property</code></b>:
188 <code>__get__</code>,
189 <code>__init__</code>,
190 <code>__property_config__</code>,
191 <code>__set__</code>,
192 <code>datastore_type</code>,
193 <code>default_value</code>,
194 <code>empty</code>,
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]195 <code>get_updated_value_for_datastore</code>,
196 <code>make_value_from_datastore_index_value</code>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]197 </p>
198 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Property</code></b> (private):
199 <code>_attr_name</code>,
200 <code>_require_parameter</code>
201 </p></div>
202 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
203 <code>__delattr__</code>,
204 <code>__format__</code>,
205 <code>__getattribute__</code>,
206 <code>__hash__</code>,
207 <code>__new__</code>,
208 <code>__reduce__</code>,
209 <code>__reduce_ex__</code>,
210 <code>__repr__</code>,
211 <code>__setattr__</code>,
212 <code>__sizeof__</code>,
213 <code>__str__</code>,
214 <code>__subclasshook__</code>
215 </p>
216 </td>
217 </tr>
218</table>
219<!-- ==================== CLASS VARIABLES ==================== -->
220<a name="section-ClassVariables"></a>
221<table class="summary" border="1" cellpadding="3"
222 cellspacing="0" width="100%" bgcolor="white">
223<tr bgcolor="#70b0f0" class="table-header">
224 <td colspan="2" class="table-header">
225 <table border="0" cellpadding="0" cellspacing="0" width="100%">
226 <tr valign="top">
227 <td align="left"><span class="table-header">Class Variables</span></td>
228 <td align="right" valign="top"
229 ><span class="options">[<a href="#section-ClassVariables"
230 class="privatelink" onclick="toggle_private();"
231 >hide private</a>]</span></td>
232 </tr>
233 </table>
234 </td>
235</tr>
236 <tr>
237 <td colspan="2" class="summary">
238 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Property</code></b>:
239 <code>creation_counter</code>
240 </p>
241 </td>
242 </tr>
243</table>
244<!-- ==================== PROPERTIES ==================== -->
245<a name="section-Properties"></a>
246<table class="summary" border="1" cellpadding="3"
247 cellspacing="0" width="100%" bgcolor="white">
248<tr bgcolor="#70b0f0" class="table-header">
249 <td colspan="2" class="table-header">
250 <table border="0" cellpadding="0" cellspacing="0" width="100%">
251 <tr valign="top">
252 <td align="left"><span class="table-header">Properties</span></td>
253 <td align="right" valign="top"
254 ><span class="options">[<a href="#section-Properties"
255 class="privatelink" onclick="toggle_private();"
256 >hide private</a>]</span></td>
257 </tr>
258 </table>
259 </td>
260</tr>
261 <tr>
262 <td colspan="2" class="summary">
263 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
264 <code>__class__</code>
265 </p>
266 </td>
267 </tr>
268</table>
269<!-- ==================== METHOD DETAILS ==================== -->
270<a name="section-MethodDetails"></a>
271<table class="details" border="1" cellpadding="3"
272 cellspacing="0" width="100%" bgcolor="white">
273<tr bgcolor="#70b0f0" class="table-header">
274 <td colspan="2" class="table-header">
275 <table border="0" cellpadding="0" cellspacing="0" width="100%">
276 <tr valign="top">
277 <td align="left"><span class="table-header">Method Details</span></td>
278 <td align="right" valign="top"
279 ><span class="options">[<a href="#section-MethodDetails"
280 class="privatelink" onclick="toggle_private();"
281 >hide private</a>]</span></td>
282 </tr>
283 </table>
284 </td>
285</tr>
286</table>
287<a name="get_value_for_datastore"></a>
288<div>
289<table class="details" border="1" cellpadding="3"
290 cellspacing="0" width="100%" bgcolor="white">
291<tr><td>
292 <table width="100%" cellpadding="0" cellspacing="0" border="0">
293 <tr valign="top"><td>
294 <h3 class="epydoc"><span class="sig"><span class="sig-name">get_value_for_datastore</span>(<span class="sig-arg">self</span>,
295 <span class="sig-arg">model_instance</span>)</span>
296 </h3>
297 </td><td align="right" valign="top"
298 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsProperty.get_value_for_datastore">source&nbsp;code</a></span>&nbsp;
299 </td>
300 </tr></table>
301
302 <pre class="literalblock">
303Datastore representation of this property.
304
305Looks for this property in the given model instance, and returns the proper
306datastore representation of the value that can be stored in a datastore
307entity. Most critically, it will fetch the datastore key value for
308reference properties.
309
310Some properies (e.g. DateTimeProperty, UserProperty) optionally update their
311value on every put(). This call must return the current value for such
312properties (get_updated_value_for_datastore returns the new value).
313
314Args:
315 model_instance: Instance to fetch datastore value from.
316
317Returns:
318 Datastore representation of the model value in a form that is
319 appropriate for storing in the datastore.
320
321</pre>
322 <dl class="fields">
323 <dt>Overrides:
324 google.appengine.ext.db.Property.get_value_for_datastore
325 <dd><em class="note">(inherited documentation)</em></dd>
326 </dt>
327 </dl>
328</td></tr></table>
329</div>
330<a name="make_value_from_datastore"></a>
331<div>
332<table class="details" border="1" cellpadding="3"
333 cellspacing="0" width="100%" bgcolor="white">
334<tr><td>
335 <table width="100%" cellpadding="0" cellspacing="0" border="0">
336 <tr valign="top"><td>
337 <h3 class="epydoc"><span class="sig"><span class="sig-name">make_value_from_datastore</span>(<span class="sig-arg">self</span>,
338 <span class="sig-arg">value</span>)</span>
339 </h3>
340 </td><td align="right" valign="top"
341 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsProperty.make_value_from_datastore">source&nbsp;code</a></span>&nbsp;
342 </td>
343 </tr></table>
344
345 <pre class="literalblock">
346Native representation of this property.
347
348Given a value retrieved from a datastore entity, return a value,
349possibly converted, to be stored on the model instance. Usually
350this returns the value unchanged, but a property class may
351override this when it uses a different datatype on the model
352instance than on the entity.
353
354This API is not quite symmetric with get_value_for_datastore(),
355because the model instance on which to store the converted value
356may not exist yet -- we may be collecting values to be passed to a
357model constructor.
358
359Args:
360 value: value retrieved from the datastore entity.
361
362Returns:
363 The value converted for use as a model instance attribute.
364
365</pre>
366 <dl class="fields">
367 <dt>Overrides:
368 google.appengine.ext.db.Property.make_value_from_datastore
369 <dd><em class="note">(inherited documentation)</em></dd>
370 </dt>
371 </dl>
372</td></tr></table>
373</div>
374<a name="validate"></a>
375<div>
376<table class="details" border="1" cellpadding="3"
377 cellspacing="0" width="100%" bgcolor="white">
378<tr><td>
379 <table width="100%" cellpadding="0" cellspacing="0" border="0">
380 <tr valign="top"><td>
381 <h3 class="epydoc"><span class="sig"><span class="sig-name">validate</span>(<span class="sig-arg">self</span>,
382 <span class="sig-arg">value</span>)</span>
383 </h3>
384 </td><td align="right" valign="top"
385 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsProperty.validate">source&nbsp;code</a></span>&nbsp;
386 </td>
387 </tr></table>
388
389 <pre class="literalblock">
390Assert that provided value is compatible with this property.
391
392Args:
393 value: Value to validate against this Property.
394
395Returns:
396 A valid value, either the input unchanged or adapted to the
397 required type.
398
399Raises:
400 BadValueError if the value is not appropriate for this
401 property in any way.
402
403</pre>
404 <dl class="fields">
405 <dt>Overrides:
406 google.appengine.ext.db.Property.validate
407 <dd><em class="note">(inherited documentation)</em></dd>
408 </dt>
409 </dl>
410</td></tr></table>
411</div>
412<br />
413<!-- ==================== NAVIGATION BAR ==================== -->
414<table class="navbar" border="0" width="100%" cellpadding="0"
415 bgcolor="#a0c0ff" cellspacing="0">
416 <tr valign="middle">
417
418 <!-- Tree link -->
419 <th>&nbsp;&nbsp;&nbsp;<a
420 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
421
422 <!-- Index link -->
423 <th>&nbsp;&nbsp;&nbsp;<a
424 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
425
426 <!-- Help link -->
427 <th>&nbsp;&nbsp;&nbsp;<a
428 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
429
430 <th class="navbar" width="100%"></th>
431 </tr>
432</table>
433<table border="0" cellpadding="0" cellspacing="0" width="100%%">
434 <tr>
435 <td align="left" class="footer">
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]436 Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:57 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]437 </td>
438 <td align="right" class="footer">
439 <a target="mainFrame" href="http://epydoc.sourceforge.net"
440 >http://epydoc.sourceforge.net</a>
441 </td>
442 </tr>
443</table>
444
445<script type="text/javascript">
446 <!--
447 // Private objects are initially displayed (because if
448 // javascript is turned off then we want them to be
449 // visible); but by default, we want to hide them. So hide
450 // them unless we have a cookie that says to show them.
451 checkCookie();
452 // -->
453</script>
454</body>
455</html>