blob: 5b08c6039fb5047105e00bea2caf8b9fe8b4e287 [file] [log] [blame]
Joe Gregorio1b425aa2012-08-24 12:04:34 -04001<?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.SiteXsrfSecretKey</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;SiteXsrfSecretKey
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.SiteXsrfSecretKey-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 SiteXsrfSecretKey</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.appengine-pysrc.html#SiteXsrfSecretKey">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="class_hierarchy_for_sitexsrfse" name="class_hierarchy_for_sitexsrfse">
59<area shape="rect" href="javascript:void(0);" title="google.appengine.ext.db.Model" alt="" coords="5,5,205,32"/>
60<area shape="rect" href="oauth2client.appengine.SiteXsrfSecretKey-class.html" title="SiteXsrfSecretKey" alt="" coords="43,61,168,88"/>
61</map>
62 <img src="class_hierarchy_for_sitexsrfse.gif" alt='' usemap="#class_hierarchy_for_sitexsrfse" ismap="ismap" class="graph-without-title" />
63</center>
64</center>
65<hr />
66<pre class="literalblock">
67Storage for the sites XSRF secret key.
68
69There will only be one instance stored of this model, the one used for the
70site.
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 colspan="2" class="summary">
93 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b>:
94 <code><a href="google.appengine.ext.db.PropertiedClass-class.html">__metaclass__</a></code>
95 </p>
96 </td>
97 </tr>
98</table>
99<!-- ==================== INSTANCE METHODS ==================== -->
100<a name="section-InstanceMethods"></a>
101<table class="summary" border="1" cellpadding="3"
102 cellspacing="0" width="100%" bgcolor="white">
103<tr bgcolor="#70b0f0" class="table-header">
104 <td colspan="2" class="table-header">
105 <table border="0" cellpadding="0" cellspacing="0" width="100%">
106 <tr valign="top">
107 <td align="left"><span class="table-header">Instance Methods</span></td>
108 <td align="right" valign="top"
109 ><span class="options">[<a href="#section-InstanceMethods"
110 class="privatelink" onclick="toggle_private();"
111 >hide private</a>]</span></td>
112 </tr>
113 </table>
114 </td>
115</tr>
116 <tr>
117 <td colspan="2" class="summary">
118 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b>:
119 <code>__init__</code>,
120 <code>delete</code>,
121 <code>dynamic_properties</code>,
122 <code>has_key</code>,
123 <code>instance_properties</code>,
124 <code>is_saved</code>,
125 <code>key</code>,
126 <code>parent</code>,
127 <code>parent_key</code>,
128 <code>put</code>,
129 <code>save</code>,
130 <code>to_xml</code>
131 </p>
132 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b> (private):
133 <code>_populate_entity</code>,
134 <code>_populate_internal_entity</code>,
135 <code>_to_entity</code>
136 </p></div>
137 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
138 <code>__delattr__</code>,
139 <code>__format__</code>,
140 <code>__getattribute__</code>,
141 <code>__hash__</code>,
142 <code>__reduce__</code>,
143 <code>__reduce_ex__</code>,
144 <code>__repr__</code>,
145 <code>__setattr__</code>,
146 <code>__sizeof__</code>,
147 <code>__str__</code>,
148 <code>__subclasshook__</code>
149 </p>
150 </td>
151 </tr>
152</table>
153<!-- ==================== CLASS METHODS ==================== -->
154<a name="section-ClassMethods"></a>
155<table class="summary" border="1" cellpadding="3"
156 cellspacing="0" width="100%" bgcolor="white">
157<tr bgcolor="#70b0f0" class="table-header">
158 <td colspan="2" class="table-header">
159 <table border="0" cellpadding="0" cellspacing="0" width="100%">
160 <tr valign="top">
161 <td align="left"><span class="table-header">Class Methods</span></td>
162 <td align="right" valign="top"
163 ><span class="options">[<a href="#section-ClassMethods"
164 class="privatelink" onclick="toggle_private();"
165 >hide private</a>]</span></td>
166 </tr>
167 </table>
168 </td>
169</tr>
170 <tr>
171 <td colspan="2" class="summary">
172 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b>:
173 <code>all</code>,
174 <code>entity_type</code>,
175 <code>fields</code>,
176 <code>from_entity</code>,
177 <code>get</code>,
178 <code>get_by_id</code>,
179 <code>get_by_key_name</code>,
180 <code>get_or_insert</code>,
181 <code>gql</code>,
182 <code>kind</code>,
183 <code>properties</code>
184 </p>
185 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b> (private):
186 <code>_load_entity_values</code>
187 </p></div>
188 </td>
189 </tr>
190</table>
191<!-- ==================== STATIC METHODS ==================== -->
192<a name="section-StaticMethods"></a>
193<table class="summary" border="1" cellpadding="3"
194 cellspacing="0" width="100%" bgcolor="white">
195<tr bgcolor="#70b0f0" class="table-header">
196 <td colspan="2" class="table-header">
197 <table border="0" cellpadding="0" cellspacing="0" width="100%">
198 <tr valign="top">
199 <td align="left"><span class="table-header">Static Methods</span></td>
200 <td align="right" valign="top"
201 ><span class="options">[<a href="#section-StaticMethods"
202 class="privatelink" onclick="toggle_private();"
203 >hide private</a>]</span></td>
204 </tr>
205 </table>
206 </td>
207</tr>
208 <tr>
209 <td colspan="2" class="summary">
210 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b>:
211 <code>__new__</code>
212 </p>
213 </td>
214 </tr>
215</table>
216<!-- ==================== CLASS VARIABLES ==================== -->
217<a name="section-ClassVariables"></a>
218<table class="summary" border="1" cellpadding="3"
219 cellspacing="0" width="100%" bgcolor="white">
220<tr bgcolor="#70b0f0" class="table-header">
221 <td colspan="2" class="table-header">
222 <table border="0" cellpadding="0" cellspacing="0" width="100%">
223 <tr valign="top">
224 <td align="left"><span class="table-header">Class Variables</span></td>
225 <td align="right" valign="top"
226 ><span class="options">[<a href="#section-ClassVariables"
227 class="privatelink" onclick="toggle_private();"
228 >hide private</a>]</span></td>
229 </tr>
230 </table>
231 </td>
232</tr>
233<tr>
234 <td width="15%" align="right" valign="top" class="summary">
235 <span class="summary-type">&nbsp;</span>
236 </td><td class="summary">
237 <a name="secret"></a><span class="summary-name">secret</span> = <code title="db.StringProperty()">db.StringProperty()</code>
238 </td>
239 </tr>
240<tr class="private">
241 <td width="15%" align="right" valign="top" class="summary">
242 <span class="summary-type">&nbsp;</span>
243 </td><td class="summary">
244 <a name="_all_properties"></a><span class="summary-name">_all_properties</span> = <code title="frozenset(['secret'])"><code class="variable-group">frozenset([</code><code class="variable-quote">'</code><code class="variable-string">secret</code><code class="variable-quote">'</code><code class="variable-group">])</code></code>
245 </td>
246 </tr>
247<tr class="private">
248 <td width="15%" align="right" valign="top" class="summary">
249 <span class="summary-type">&nbsp;</span>
250 </td><td class="summary">
251 <a href="oauth2client.appengine.SiteXsrfSecretKey-class.html#_properties" class="summary-name" onclick="show_private();">_properties</a> = <code title="{'secret': &lt;google.appengine.ext.db.StringProperty object at 0x2717450\
252&gt;}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">secret</code><code class="variable-quote">'</code><code class="variable-op">: </code>&lt;google.appengine.ext.db.StringProper<code class="variable-ellipsis">...</code></code>
253 </td>
254 </tr>
255 <tr>
256 <td colspan="2" class="summary">
257 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b> (private):
258 <code>_unindexed_properties</code>
259 </p></div>
260 </td>
261 </tr>
262</table>
263<!-- ==================== PROPERTIES ==================== -->
264<a name="section-Properties"></a>
265<table class="summary" border="1" cellpadding="3"
266 cellspacing="0" width="100%" bgcolor="white">
267<tr bgcolor="#70b0f0" class="table-header">
268 <td colspan="2" class="table-header">
269 <table border="0" cellpadding="0" cellspacing="0" width="100%">
270 <tr valign="top">
271 <td align="left"><span class="table-header">Properties</span></td>
272 <td align="right" valign="top"
273 ><span class="options">[<a href="#section-Properties"
274 class="privatelink" onclick="toggle_private();"
275 >hide private</a>]</span></td>
276 </tr>
277 </table>
278 </td>
279</tr>
280 <tr>
281 <td colspan="2" class="summary">
282 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
283 <code>__class__</code>
284 </p>
285 </td>
286 </tr>
287</table>
288<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
289<a name="section-ClassVariableDetails"></a>
290<table class="details" border="1" cellpadding="3"
291 cellspacing="0" width="100%" bgcolor="white">
292<tr bgcolor="#70b0f0" class="table-header">
293 <td colspan="2" class="table-header">
294 <table border="0" cellpadding="0" cellspacing="0" width="100%">
295 <tr valign="top">
296 <td align="left"><span class="table-header">Class Variable Details</span></td>
297 <td align="right" valign="top"
298 ><span class="options">[<a href="#section-ClassVariableDetails"
299 class="privatelink" onclick="toggle_private();"
300 >hide private</a>]</span></td>
301 </tr>
302 </table>
303 </td>
304</tr>
305</table>
306<a name="_properties"></a>
307<div class="private">
308<table class="details" border="1" cellpadding="3"
309 cellspacing="0" width="100%" bgcolor="white">
310<tr><td>
311 <h3 class="epydoc">_properties</h3>
312
313 <dl class="fields">
314 </dl>
315 <dl class="fields">
316 <dt>Value:</dt>
317 <dd><table><tr><td><pre class="variable">
318<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">secret</code><code class="variable-quote">'</code><code class="variable-op">: </code>&lt;google.appengine.ext.db.StringProperty object at 0x2717450<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
319&gt;<code class="variable-group">}</code>
320</pre></td></tr></table>
321</dd>
322 </dl>
323</td></tr></table>
324</div>
325<br />
326<!-- ==================== NAVIGATION BAR ==================== -->
327<table class="navbar" border="0" width="100%" cellpadding="0"
328 bgcolor="#a0c0ff" cellspacing="0">
329 <tr valign="middle">
330
331 <!-- Tree link -->
332 <th>&nbsp;&nbsp;&nbsp;<a
333 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
334
335 <!-- Index link -->
336 <th>&nbsp;&nbsp;&nbsp;<a
337 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
338
339 <!-- Help link -->
340 <th>&nbsp;&nbsp;&nbsp;<a
341 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
342
343 <th class="navbar" width="100%"></th>
344 </tr>
345</table>
346<table border="0" cellpadding="0" cellspacing="0" width="100%%">
347 <tr>
348 <td align="left" class="footer">
349 Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:05 2012
350 </td>
351 <td align="right" class="footer">
352 <a target="mainFrame" href="http://epydoc.sourceforge.net"
353 >http://epydoc.sourceforge.net</a>
354 </td>
355 </tr>
356</table>
357
358<script type="text/javascript">
359 <!--
360 // Private objects are initially displayed (because if
361 // javascript is turned off then we want them to be
362 // visible); but by default, we want to hide them. So hide
363 // them unless we have a cookie that says to show them.
364 checkCookie();
365 // -->
366</script>
367</body>
368</html>