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