Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c211bec621911c2d3b448c7e1e5a39cf36f14b3b / . / docs / epy / oauth2client.appengine.FlowProperty-class.html
blob: fcda59f40bf2bdd86a0557147c147fb7ddf62862 [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.FlowProperty</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;FlowProperty
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.FlowProperty-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 FlowProperty</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty">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_flowproper" name="class_hierarchy_for_flowproper">
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]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.FlowProperty-class.html" title="FlowProperty" alt="" coords="245,6,344,34"/>
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_flowproper.gif" alt='' usemap="#class_hierarchy_for_flowproper" 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 Flow.
68
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]69Utility property that allows easy storage and retrieval of an
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]70oauth2client.Flow
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.FlowProperty-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#FlowProperty.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.FlowProperty-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#FlowProperty.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.FlowProperty-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#FlowProperty.validate">source&nbsp;code</a></span>
138
139 </td>
140 </tr>
141 </table>
142
143 </td>
144 </tr>
145<tr>
146 <td width="15%" align="right" valign="top" class="summary">
147 <span class="summary-type">&nbsp;</span>
148 </td><td class="summary">
149 <table width="100%" cellpadding="0" cellspacing="0" border="0">
150 <tr>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]151 <td><span class="summary-sig"><a href="oauth2client.appengine.FlowProperty-class.html#empty" class="summary-sig-name">empty</a>(<span class="summary-sig-arg">self</span>,
152 <span class="summary-sig-arg">value</span>)</span><br />
153 Determine if value is empty in the context of this property.</td>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]154 <td align="right" valign="top">
155 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.empty">source&nbsp;code</a></span>
156
157 </td>
158 </tr>
159 </table>
160
161 </td>
162 </tr>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]163 <tr>
164 <td colspan="2" class="summary">
165 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Property</code></b>:
166 <code>__get__</code>,
167 <code>__init__</code>,
168 <code>__property_config__</code>,
169 <code>__set__</code>,
170 <code>datastore_type</code>,
171 <code>default_value</code>,
172 <code>get_updated_value_for_datastore</code>,
173 <code>make_value_from_datastore_index_value</code>
174 </p>
175 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Property</code></b> (private):
176 <code>_attr_name</code>,
177 <code>_require_parameter</code>
178 </p></div>
179 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
180 <code>__delattr__</code>,
181 <code>__format__</code>,
182 <code>__getattribute__</code>,
183 <code>__hash__</code>,
184 <code>__new__</code>,
185 <code>__reduce__</code>,
186 <code>__reduce_ex__</code>,
187 <code>__repr__</code>,
188 <code>__setattr__</code>,
189 <code>__sizeof__</code>,
190 <code>__str__</code>,
191 <code>__subclasshook__</code>
192 </p>
193 </td>
194 </tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]195</table>
196<!-- ==================== CLASS VARIABLES ==================== -->
197<a name="section-ClassVariables"></a>
198<table class="summary" border="1" cellpadding="3"
199 cellspacing="0" width="100%" bgcolor="white">
200<tr bgcolor="#70b0f0" class="table-header">
201 <td colspan="2" class="table-header">
202 <table border="0" cellpadding="0" cellspacing="0" width="100%">
203 <tr valign="top">
204 <td align="left"><span class="table-header">Class Variables</span></td>
205 <td align="right" valign="top"
206 ><span class="options">[<a href="#section-ClassVariables"
207 class="privatelink" onclick="toggle_private();"
208 >hide private</a>]</span></td>
209 </tr>
210 </table>
211 </td>
212</tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]213<tr>
214 <td width="15%" align="right" valign="top" class="summary">
215 <span class="summary-type">&nbsp;</span>
216 </td><td class="summary">
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]217 <a name="data_type"></a><span class="summary-name">data_type</span> = <code title="Flow">Flow</code><br />
218 str(object) -&gt; string
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>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]226 </td>
227 </tr>
228</table>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]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#FlowProperty.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#FlowProperty.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#FlowProperty.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<a name="empty"></a>
398<div>
399<table class="details" border="1" cellpadding="3"
400 cellspacing="0" width="100%" bgcolor="white">
401<tr><td>
402 <table width="100%" cellpadding="0" cellspacing="0" border="0">
403 <tr valign="top"><td>
404 <h3 class="epydoc"><span class="sig"><span class="sig-name">empty</span>(<span class="sig-arg">self</span>,
405 <span class="sig-arg">value</span>)</span>
406 </h3>
407 </td><td align="right" valign="top"
408 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.empty">source&nbsp;code</a></span>&nbsp;
409 </td>
410 </tr></table>
411
412 <pre class="literalblock">
413Determine if value is empty in the context of this property.
414
415For most kinds, this is equivalent to &quot;not value&quot;, but for kinds like
416bool, the test is more subtle, so subclasses can override this method
417if necessary.
418
419Args:
420 value: Value to validate against this Property.
421
422Returns:
423 True if this value is considered empty in the context of this Property
424 type, otherwise False.
425
426</pre>
427 <dl class="fields">
428 <dt>Overrides:
429 google.appengine.ext.db.Property.empty
430 <dd><em class="note">(inherited documentation)</em></dd>
431 </dt>
432 </dl>
433</td></tr></table>
434</div>
435<br />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]436<!-- ==================== NAVIGATION BAR ==================== -->
437<table class="navbar" border="0" width="100%" cellpadding="0"
438 bgcolor="#a0c0ff" cellspacing="0">
439 <tr valign="middle">
440
441 <!-- Tree link -->
442 <th>&nbsp;&nbsp;&nbsp;<a
443 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
444
445 <!-- Index link -->
446 <th>&nbsp;&nbsp;&nbsp;<a
447 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
448
449 <!-- Help link -->
450 <th>&nbsp;&nbsp;&nbsp;<a
451 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
452
453 <th class="navbar" width="100%"></th>
454 </tr>
455</table>
456<table border="0" cellpadding="0" cellspacing="0" width="100%%">
457 <tr>
458 <td align="left" class="footer">
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]459 Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:24 2013
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]460 </td>
461 <td align="right" class="footer">
462 <a target="mainFrame" href="http://epydoc.sourceforge.net"
463 >http://epydoc.sourceforge.net</a>
464 </td>
465 </tr>
466</table>
467
468<script type="text/javascript">
469 <!--
470 // Private objects are initially displayed (because if
471 // javascript is turned off then we want them to be
472 // visible); but by default, we want to hide them. So hide
473 // them unless we have a cookie that says to show them.
474 checkCookie();
475 // -->
476</script>
477</body>
478</html>