Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 1024403cf988cb1c83348c05f0f6ff205dd5159c / . / docs / epy / oauth2client.appengine.FlowNDBProperty-class.html
blob: 7c86eb9fc33f006604a5590419f211f41d9ff6b9 [file] [log] [blame]
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[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.FlowNDBProperty</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;FlowNDBProperty
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.FlowNDBProperty-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 FlowNDBProperty</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowNDBProperty">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="class_hierarchy_for_flowndbpro" name="class_hierarchy_for_flowndbpro">
59<area shape="rect" id="node1" href="javascript:void(0);" title="google.appengine.ext.ndb.PickleProperty" alt="" coords="5,6,264,34"/>
60<area shape="rect" id="node2" href="oauth2client.appengine.FlowNDBProperty-class.html" title="FlowNDBProperty" alt="" coords="288,6,416,34"/>
61</map>
62 <img src="class_hierarchy_for_flowndbpro.gif" alt='' usemap="#class_hierarchy_for_flowndbpro" ismap="ismap" class="graph-without-title" />
63</center>
64</center>
65<hr />
66<pre class="literalblock">
67App Engine NDB datastore Property for Flow.
68
69Serves the same purpose as the DB FlowProperty, but for NDB models. Since
70PickleProperty inherits from BlobProperty, the underlying representation of
71the data in the datastore will be the same as in the DB case.
72
73Utility property that allows easy storage and retrieval of an
74oauth2client.Flow
75
76</pre>
77
78<!-- ==================== INSTANCE METHODS ==================== -->
79<a name="section-InstanceMethods"></a>
80<table class="summary" border="1" cellpadding="3"
81 cellspacing="0" width="100%" bgcolor="white">
82<tr bgcolor="#70b0f0" class="table-header">
83 <td colspan="2" class="table-header">
84 <table border="0" cellpadding="0" cellspacing="0" width="100%">
85 <tr valign="top">
86 <td align="left"><span class="table-header">Instance Methods</span></td>
87 <td align="right" valign="top"
88 ><span class="options">[<a href="#section-InstanceMethods"
89 class="privatelink" onclick="toggle_private();"
90 >hide private</a>]</span></td>
91 </tr>
92 </table>
93 </td>
94</tr>
95<tr class="private">
96 <td width="15%" align="right" valign="top" class="summary">
97 <span class="summary-type">&nbsp;</span>
98 </td><td class="summary">
99 <table width="100%" cellpadding="0" cellspacing="0" border="0">
100 <tr>
101 <td><span class="summary-sig"><a href="oauth2client.appengine.FlowNDBProperty-class.html#_validate" class="summary-sig-name" onclick="show_private();">_validate</a>(<span class="summary-sig-arg">self</span>,
102 <span class="summary-sig-arg">value</span>)</span><br />
103 Validates a value as a proper Flow object.</td>
104 <td align="right" valign="top">
105 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowNDBProperty._validate">source&nbsp;code</a></span>
106
107 </td>
108 </tr>
109 </table>
110
111 </td>
112 </tr>
113</table>
114<!-- ==================== METHOD DETAILS ==================== -->
115<a name="section-MethodDetails"></a>
116<table class="details" 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">Method Details</span></td>
123 <td align="right" valign="top"
124 ><span class="options">[<a href="#section-MethodDetails"
125 class="privatelink" onclick="toggle_private();"
126 >hide private</a>]</span></td>
127 </tr>
128 </table>
129 </td>
130</tr>
131</table>
132<a name="_validate"></a>
133<div class="private">
134<table class="details" border="1" cellpadding="3"
135 cellspacing="0" width="100%" bgcolor="white">
136<tr><td>
137 <table width="100%" cellpadding="0" cellspacing="0" border="0">
138 <tr valign="top"><td>
139 <h3 class="epydoc"><span class="sig"><span class="sig-name">_validate</span>(<span class="sig-arg">self</span>,
140 <span class="sig-arg">value</span>)</span>
141 </h3>
142 </td><td align="right" valign="top"
143 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowNDBProperty._validate">source&nbsp;code</a></span>&nbsp;
144 </td>
145 </tr></table>
146
147 <pre class="literalblock">
148Validates a value as a proper Flow object.
149
150Args:
151 value: A value to be set on the property.
152
153Raises:
154 TypeError if the value is not an instance of Flow.
155
156</pre>
157 <dl class="fields">
158 </dl>
159</td></tr></table>
160</div>
161<br />
162<!-- ==================== NAVIGATION BAR ==================== -->
163<table class="navbar" border="0" width="100%" cellpadding="0"
164 bgcolor="#a0c0ff" cellspacing="0">
165 <tr valign="middle">
166
167 <!-- Tree link -->
168 <th>&nbsp;&nbsp;&nbsp;<a
169 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
170
171 <!-- Index link -->
172 <th>&nbsp;&nbsp;&nbsp;<a
173 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
174
175 <!-- Help link -->
176 <th>&nbsp;&nbsp;&nbsp;<a
177 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
178
179 <th class="navbar" width="100%"></th>
180 </tr>
181</table>
182<table border="0" cellpadding="0" cellspacing="0" width="100%%">
183 <tr>
184 <td align="left" class="footer">
185 Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:39 2013
186 </td>
187 <td align="right" class="footer">
188 <a target="mainFrame" href="http://epydoc.sourceforge.net"
189 >http://epydoc.sourceforge.net</a>
190 </td>
191 </tr>
192</table>
193
194<script type="text/javascript">
195 <!--
196 // Private objects are initially displayed (because if
197 // javascript is turned off then we want them to be
198 // visible); but by default, we want to hide them. So hide
199 // them unless we have a cookie that says to show them.
200 checkCookie();
201 // -->
202</script>
203</body>
204</html>