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