Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 746096f91ae4fb9de9126bc013d3375306fb6854 / . / docs / epy / oauth2client.appengine.CredentialsProperty-class.html
blob: 16542eea22ca65858c6aa356615be240d43020d5 [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 Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]181 <code>get_updated_value_for_datastore</code>,
182 <code>make_value_from_datastore_index_value</code>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]183 </p>
184 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Property</code></b> (private):
185 <code>_attr_name</code>,
186 <code>_require_parameter</code>
187 </p></div>
188 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
189 <code>__delattr__</code>,
190 <code>__format__</code>,
191 <code>__getattribute__</code>,
192 <code>__hash__</code>,
193 <code>__new__</code>,
194 <code>__reduce__</code>,
195 <code>__reduce_ex__</code>,
196 <code>__repr__</code>,
197 <code>__setattr__</code>,
198 <code>__sizeof__</code>,
199 <code>__str__</code>,
200 <code>__subclasshook__</code>
201 </p>
202 </td>
203 </tr>
204</table>
205<!-- ==================== CLASS VARIABLES ==================== -->
206<a name="section-ClassVariables"></a>
207<table class="summary" border="1" cellpadding="3"
208 cellspacing="0" width="100%" bgcolor="white">
209<tr bgcolor="#70b0f0" class="table-header">
210 <td colspan="2" class="table-header">
211 <table border="0" cellpadding="0" cellspacing="0" width="100%">
212 <tr valign="top">
213 <td align="left"><span class="table-header">Class Variables</span></td>
214 <td align="right" valign="top"
215 ><span class="options">[<a href="#section-ClassVariables"
216 class="privatelink" onclick="toggle_private();"
217 >hide private</a>]</span></td>
218 </tr>
219 </table>
220 </td>
221</tr>
222 <tr>
223 <td colspan="2" class="summary">
224 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Property</code></b>:
225 <code>creation_counter</code>
226 </p>
227 </td>
228 </tr>
229</table>
230<!-- ==================== PROPERTIES ==================== -->
231<a name="section-Properties"></a>
232<table class="summary" border="1" cellpadding="3"
233 cellspacing="0" width="100%" bgcolor="white">
234<tr bgcolor="#70b0f0" class="table-header">
235 <td colspan="2" class="table-header">
236 <table border="0" cellpadding="0" cellspacing="0" width="100%">
237 <tr valign="top">
238 <td align="left"><span class="table-header">Properties</span></td>
239 <td align="right" valign="top"
240 ><span class="options">[<a href="#section-Properties"
241 class="privatelink" onclick="toggle_private();"
242 >hide private</a>]</span></td>
243 </tr>
244 </table>
245 </td>
246</tr>
247 <tr>
248 <td colspan="2" class="summary">
249 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
250 <code>__class__</code>
251 </p>
252 </td>
253 </tr>
254</table>
255<!-- ==================== METHOD DETAILS ==================== -->
256<a name="section-MethodDetails"></a>
257<table class="details" border="1" cellpadding="3"
258 cellspacing="0" width="100%" bgcolor="white">
259<tr bgcolor="#70b0f0" class="table-header">
260 <td colspan="2" class="table-header">
261 <table border="0" cellpadding="0" cellspacing="0" width="100%">
262 <tr valign="top">
263 <td align="left"><span class="table-header">Method Details</span></td>
264 <td align="right" valign="top"
265 ><span class="options">[<a href="#section-MethodDetails"
266 class="privatelink" onclick="toggle_private();"
267 >hide private</a>]</span></td>
268 </tr>
269 </table>
270 </td>
271</tr>
272</table>
273<a name="get_value_for_datastore"></a>
274<div>
275<table class="details" border="1" cellpadding="3"
276 cellspacing="0" width="100%" bgcolor="white">
277<tr><td>
278 <table width="100%" cellpadding="0" cellspacing="0" border="0">
279 <tr valign="top"><td>
280 <h3 class="epydoc"><span class="sig"><span class="sig-name">get_value_for_datastore</span>(<span class="sig-arg">self</span>,
281 <span class="sig-arg">model_instance</span>)</span>
282 </h3>
283 </td><td align="right" valign="top"
284 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsProperty.get_value_for_datastore">source&nbsp;code</a></span>&nbsp;
285 </td>
286 </tr></table>
287
288 <pre class="literalblock">
289Datastore representation of this property.
290
291Looks for this property in the given model instance, and returns the proper
292datastore representation of the value that can be stored in a datastore
293entity. Most critically, it will fetch the datastore key value for
294reference properties.
295
296Some properies (e.g. DateTimeProperty, UserProperty) optionally update their
297value on every put(). This call must return the current value for such
298properties (get_updated_value_for_datastore returns the new value).
299
300Args:
301 model_instance: Instance to fetch datastore value from.
302
303Returns:
304 Datastore representation of the model value in a form that is
305 appropriate for storing in the datastore.
306
307</pre>
308 <dl class="fields">
309 <dt>Overrides:
310 google.appengine.ext.db.Property.get_value_for_datastore
311 <dd><em class="note">(inherited documentation)</em></dd>
312 </dt>
313 </dl>
314</td></tr></table>
315</div>
316<a name="make_value_from_datastore"></a>
317<div>
318<table class="details" border="1" cellpadding="3"
319 cellspacing="0" width="100%" bgcolor="white">
320<tr><td>
321 <table width="100%" cellpadding="0" cellspacing="0" border="0">
322 <tr valign="top"><td>
323 <h3 class="epydoc"><span class="sig"><span class="sig-name">make_value_from_datastore</span>(<span class="sig-arg">self</span>,
324 <span class="sig-arg">value</span>)</span>
325 </h3>
326 </td><td align="right" valign="top"
327 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsProperty.make_value_from_datastore">source&nbsp;code</a></span>&nbsp;
328 </td>
329 </tr></table>
330
331 <pre class="literalblock">
332Native representation of this property.
333
334Given a value retrieved from a datastore entity, return a value,
335possibly converted, to be stored on the model instance. Usually
336this returns the value unchanged, but a property class may
337override this when it uses a different datatype on the model
338instance than on the entity.
339
340This API is not quite symmetric with get_value_for_datastore(),
341because the model instance on which to store the converted value
342may not exist yet -- we may be collecting values to be passed to a
343model constructor.
344
345Args:
346 value: value retrieved from the datastore entity.
347
348Returns:
349 The value converted for use as a model instance attribute.
350
351</pre>
352 <dl class="fields">
353 <dt>Overrides:
354 google.appengine.ext.db.Property.make_value_from_datastore
355 <dd><em class="note">(inherited documentation)</em></dd>
356 </dt>
357 </dl>
358</td></tr></table>
359</div>
360<a name="validate"></a>
361<div>
362<table class="details" border="1" cellpadding="3"
363 cellspacing="0" width="100%" bgcolor="white">
364<tr><td>
365 <table width="100%" cellpadding="0" cellspacing="0" border="0">
366 <tr valign="top"><td>
367 <h3 class="epydoc"><span class="sig"><span class="sig-name">validate</span>(<span class="sig-arg">self</span>,
368 <span class="sig-arg">value</span>)</span>
369 </h3>
370 </td><td align="right" valign="top"
371 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsProperty.validate">source&nbsp;code</a></span>&nbsp;
372 </td>
373 </tr></table>
374
375 <pre class="literalblock">
376Assert that provided value is compatible with this property.
377
378Args:
379 value: Value to validate against this Property.
380
381Returns:
382 A valid value, either the input unchanged or adapted to the
383 required type.
384
385Raises:
386 BadValueError if the value is not appropriate for this
387 property in any way.
388
389</pre>
390 <dl class="fields">
391 <dt>Overrides:
392 google.appengine.ext.db.Property.validate
393 <dd><em class="note">(inherited documentation)</em></dd>
394 </dt>
395 </dl>
396</td></tr></table>
397</div>
398<br />
399<!-- ==================== NAVIGATION BAR ==================== -->
400<table class="navbar" border="0" width="100%" cellpadding="0"
401 bgcolor="#a0c0ff" cellspacing="0">
402 <tr valign="middle">
403
404 <!-- Tree link -->
405 <th>&nbsp;&nbsp;&nbsp;<a
406 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
407
408 <!-- Index link -->
409 <th>&nbsp;&nbsp;&nbsp;<a
410 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
411
412 <!-- Help link -->
413 <th>&nbsp;&nbsp;&nbsp;<a
414 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
415
416 <th class="navbar" width="100%"></th>
417 </tr>
418</table>
419<table border="0" cellpadding="0" cellspacing="0" width="100%%">
420 <tr>
421 <td align="left" class="footer">
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame^]422 Generated by Epydoc 3.0.1 on Fri Jun 15 09:51:50 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]423 </td>
424 <td align="right" class="footer">
425 <a target="mainFrame" href="http://epydoc.sourceforge.net"
426 >http://epydoc.sourceforge.net</a>
427 </td>
428 </tr>
429</table>
430
431<script type="text/javascript">
432 <!--
433 // Private objects are initially displayed (because if
434 // javascript is turned off then we want them to be
435 // visible); but by default, we want to hide them. So hide
436 // them unless we have a cookie that says to show them.
437 checkCookie();
438 // -->
439</script>
440</body>
441</html>