blob: 5e10a0f657d5bc34a8872a6046fd6616f9cf1ede [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>
Joe Gregorio37802c32013-08-06 12:24:05 -040058<center> <map id="uml_class_diagram_for_oauth2cl_12" name="uml_class_diagram_for_oauth2cl_12">
59<area shape="rect" id="node126" href="oauth2client.appengine.SiteXsrfSecretKey-class.html#secret" title="oauth2client.appengine.SiteXsrfSecretKey.secret" alt="" coords="220,383,331,401"/>
60<area shape="rect" id="node1" href="oauth2client.appengine.SiteXsrfSecretKey-class.html" title="Storage for the sites XSRF secret key." alt="" coords="208,358,341,415"/>
61<area shape="rect" id="node127" href="google.appengine.ext.db.PropertiedClass-class.html" title="Meta&#45;class for initializing Model classes properties." alt="" coords="17,31,533,49"/>
62<area shape="rect" id="node127" href="javascript:void(0);" title="Allow subclasses to call __new__() with arguments." alt="" coords="17,52,533,71"/>
63<area shape="rect" id="node127" href="javascript:void(0);" title="Creates a new instance of this model." alt="" coords="17,71,533,89"/>
64<area shape="rect" id="node127" href="javascript:void(0);" title="Unique key for this entity." alt="" coords="17,89,533,108"/>
65<area shape="rect" id="node127" href="javascript:void(0);" title="Writes this model instance to the datastore." alt="" coords="17,108,533,127"/>
66<area shape="rect" id="node127" href="javascript:void(0);" title="Writes this model instance to the datastore." alt="" coords="17,127,533,145"/>
67<area shape="rect" id="node127" href="javascript:void(0);" title="Deletes this entity from the datastore." alt="" coords="17,145,533,164"/>
68<area shape="rect" id="node127" href="javascript:void(0);" title="Determine if entity is persisted in the datastore." alt="" coords="17,164,533,183"/>
69<area shape="rect" id="node127" href="javascript:void(0);" title="Determine if this model instance has a complete key." alt="" coords="17,183,533,201"/>
70<area shape="rect" id="node127" href="javascript:void(0);" title="Returns a list of all dynamic properties defined for instance." alt="" coords="17,201,533,220"/>
71<area shape="rect" id="node127" href="javascript:void(0);" title="Alias for dyanmic_properties." alt="" coords="17,220,533,239"/>
72<area shape="rect" id="node127" href="javascript:void(0);" title="Get the parent of the model instance." alt="" coords="17,239,533,257"/>
73<area shape="rect" id="node127" href="javascript:void(0);" title="Get the parent&#39;s key." alt="" coords="17,257,533,276"/>
74<area shape="rect" id="node127" href="javascript:void(0);" title="Generate an XML representation of this model instance." alt="" coords="17,276,533,295"/>
75<area shape="rect" id="node127" href="javascript:void(0);" title="Soon to be removed alias for properties." alt="" coords="17,313,533,332"/>
76<area shape="rect" id="node2" href="javascript:void(0);" title="Model is the superclass of all object entities in the datastore." alt="" coords="5,6,544,338"/>
Joe Gregorio1b425aa2012-08-24 12:04:34 -040077</map>
Joe Gregorio37802c32013-08-06 12:24:05 -040078 <img src="uml_class_diagram_for_oauth2cl_12.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_12" ismap="ismap" class="graph-without-title" />
Joe Gregorio1b425aa2012-08-24 12:04:34 -040079</center>
80</center>
81<hr />
82<pre class="literalblock">
83Storage for the sites XSRF secret key.
84
85There will only be one instance stored of this model, the one used for the
Joe Gregorio52a5c532013-01-24 16:19:07 -050086site.
Joe Gregorio1b425aa2012-08-24 12:04:34 -040087
88</pre>
89
Joe Gregorio41be8e82013-03-07 10:31:47 -050090<!-- ==================== NESTED CLASSES ==================== -->
91<a name="section-NestedClasses"></a>
92<table class="summary" border="1" cellpadding="3"
93 cellspacing="0" width="100%" bgcolor="white">
94<tr bgcolor="#70b0f0" class="table-header">
95 <td colspan="2" class="table-header">
96 <table border="0" cellpadding="0" cellspacing="0" width="100%">
97 <tr valign="top">
98 <td align="left"><span class="table-header">Nested Classes</span></td>
99 <td align="right" valign="top"
100 ><span class="options">[<a href="#section-NestedClasses"
101 class="privatelink" onclick="toggle_private();"
102 >hide private</a>]</span></td>
103 </tr>
104 </table>
105 </td>
106</tr>
107 <tr>
108 <td colspan="2" class="summary">
109 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b>:
110 <code><a href="google.appengine.ext.db.PropertiedClass-class.html">__metaclass__</a></code>
111 </p>
112 </td>
113 </tr>
114</table>
115<!-- ==================== INSTANCE METHODS ==================== -->
116<a name="section-InstanceMethods"></a>
117<table class="summary" border="1" cellpadding="3"
118 cellspacing="0" width="100%" bgcolor="white">
119<tr bgcolor="#70b0f0" class="table-header">
120 <td colspan="2" class="table-header">
121 <table border="0" cellpadding="0" cellspacing="0" width="100%">
122 <tr valign="top">
123 <td align="left"><span class="table-header">Instance Methods</span></td>
124 <td align="right" valign="top"
125 ><span class="options">[<a href="#section-InstanceMethods"
126 class="privatelink" onclick="toggle_private();"
127 >hide private</a>]</span></td>
128 </tr>
129 </table>
130 </td>
131</tr>
132 <tr>
133 <td colspan="2" class="summary">
134 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b>:
135 <code>__init__</code>,
136 <code>__new__</code>,
137 <code>delete</code>,
138 <code>dynamic_properties</code>,
139 <code>has_key</code>,
140 <code>instance_properties</code>,
141 <code>is_saved</code>,
142 <code>key</code>,
143 <code>parent</code>,
144 <code>parent_key</code>,
145 <code>put</code>,
146 <code>save</code>,
147 <code>to_xml</code>
148 </p>
149 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b> (private):
150 <code>_populate_entity</code>,
151 <code>_populate_internal_entity</code>,
152 <code>_to_entity</code>
153 </p></div>
154 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
155 <code>__delattr__</code>,
156 <code>__format__</code>,
157 <code>__getattribute__</code>,
158 <code>__hash__</code>,
159 <code>__reduce__</code>,
160 <code>__reduce_ex__</code>,
161 <code>__repr__</code>,
162 <code>__setattr__</code>,
163 <code>__sizeof__</code>,
164 <code>__str__</code>,
165 <code>__subclasshook__</code>
166 </p>
167 </td>
168 </tr>
169</table>
170<!-- ==================== CLASS METHODS ==================== -->
171<a name="section-ClassMethods"></a>
172<table class="summary" border="1" cellpadding="3"
173 cellspacing="0" width="100%" bgcolor="white">
174<tr bgcolor="#70b0f0" class="table-header">
175 <td colspan="2" class="table-header">
176 <table border="0" cellpadding="0" cellspacing="0" width="100%">
177 <tr valign="top">
178 <td align="left"><span class="table-header">Class Methods</span></td>
179 <td align="right" valign="top"
180 ><span class="options">[<a href="#section-ClassMethods"
181 class="privatelink" onclick="toggle_private();"
182 >hide private</a>]</span></td>
183 </tr>
184 </table>
185 </td>
186</tr>
187 <tr>
188 <td colspan="2" class="summary">
189 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b>:
190 <code>all</code>,
191 <code>entity_type</code>,
192 <code>fields</code>,
193 <code>from_entity</code>,
194 <code>get</code>,
195 <code>get_by_id</code>,
196 <code>get_by_key_name</code>,
197 <code>get_or_insert</code>,
198 <code>gql</code>,
199 <code>kind</code>,
200 <code>properties</code>
201 </p>
202 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b> (private):
203 <code>_load_entity_values</code>
204 </p></div>
205 </td>
206 </tr>
207</table>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400208<!-- ==================== CLASS VARIABLES ==================== -->
209<a name="section-ClassVariables"></a>
210<table class="summary" border="1" cellpadding="3"
211 cellspacing="0" width="100%" bgcolor="white">
212<tr bgcolor="#70b0f0" class="table-header">
213 <td colspan="2" class="table-header">
214 <table border="0" cellpadding="0" cellspacing="0" width="100%">
215 <tr valign="top">
216 <td align="left"><span class="table-header">Class Variables</span></td>
217 <td align="right" valign="top"
218 ><span class="options">[<a href="#section-ClassVariables"
219 class="privatelink" onclick="toggle_private();"
220 >hide private</a>]</span></td>
221 </tr>
222 </table>
223 </td>
224</tr>
225<tr>
226 <td width="15%" align="right" valign="top" class="summary">
227 <span class="summary-type">&nbsp;</span>
228 </td><td class="summary">
229 <a name="secret"></a><span class="summary-name">secret</span> = <code title="db.StringProperty()">db.StringProperty()</code>
230 </td>
231 </tr>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400232</table>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500233<!-- ==================== PROPERTIES ==================== -->
234<a name="section-Properties"></a>
235<table class="summary" border="1" cellpadding="3"
236 cellspacing="0" width="100%" bgcolor="white">
237<tr bgcolor="#70b0f0" class="table-header">
238 <td colspan="2" class="table-header">
239 <table border="0" cellpadding="0" cellspacing="0" width="100%">
240 <tr valign="top">
241 <td align="left"><span class="table-header">Properties</span></td>
242 <td align="right" valign="top"
243 ><span class="options">[<a href="#section-Properties"
244 class="privatelink" onclick="toggle_private();"
245 >hide private</a>]</span></td>
246 </tr>
247 </table>
248 </td>
249</tr>
250 <tr>
251 <td colspan="2" class="summary">
252 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
253 <code>__class__</code>
254 </p>
255 </td>
256 </tr>
257</table>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400258<!-- ==================== NAVIGATION BAR ==================== -->
259<table class="navbar" border="0" width="100%" cellpadding="0"
260 bgcolor="#a0c0ff" cellspacing="0">
261 <tr valign="middle">
262
263 <!-- Tree link -->
264 <th>&nbsp;&nbsp;&nbsp;<a
265 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
266
267 <!-- Index link -->
268 <th>&nbsp;&nbsp;&nbsp;<a
269 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
270
271 <!-- Help link -->
272 <th>&nbsp;&nbsp;&nbsp;<a
273 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
274
275 <th class="navbar" width="100%"></th>
276 </tr>
277</table>
278<table border="0" cellpadding="0" cellspacing="0" width="100%%">
279 <tr>
280 <td align="left" class="footer">
Joe Gregorio37802c32013-08-06 12:24:05 -0400281 Generated by Epydoc 3.0.1 on Tue Aug 6 12:16:45 2013
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400282 </td>
283 <td align="right" class="footer">
284 <a target="mainFrame" href="http://epydoc.sourceforge.net"
285 >http://epydoc.sourceforge.net</a>
286 </td>
287 </tr>
288</table>
289
290<script type="text/javascript">
291 <!--
292 // Private objects are initially displayed (because if
293 // javascript is turned off then we want them to be
294 // visible); but by default, we want to hide them. So hide
295 // them unless we have a cookie that says to show them.
296 checkCookie();
297 // -->
298</script>
299</body>
300</html>