blob: f074fc678aa2937161e4769c6193d9fd164f2190 [file] [log] [blame]
Joe Gregorio52a5c532013-01-24 16:19:07 -05001<?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.SiteXsrfSecretKeyNDB</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;SiteXsrfSecretKeyNDB
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.SiteXsrfSecretKeyNDB-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 SiteXsrfSecretKeyNDB</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.appengine-pysrc.html#SiteXsrfSecretKeyNDB">source&nbsp;code</a></span></p>
57<center>
Joe Gregorio37802c32013-08-06 12:24:05 -040058<center> <map id="uml_class_diagram_for_oauth2cl_13" name="uml_class_diagram_for_oauth2cl_13">
59<area shape="rect" id="node128" href="oauth2client.appengine.SiteXsrfSecretKeyNDB-class.html#secret" title="oauth2client.appengine.SiteXsrfSecretKeyNDB.secret" alt="" coords="17,95,156,113"/>
60<area shape="rect" id="node1" href="oauth2client.appengine.SiteXsrfSecretKeyNDB-class.html" title="NDB Model for storage for the sites XSRF secret key." alt="" coords="5,70,168,127"/>
61<area shape="rect" id="node2" href="javascript:void(0);" title="??&#45;98" alt="" coords="57,6,116,50"/>
Joe Gregorio52a5c532013-01-24 16:19:07 -050062</map>
Joe Gregorio37802c32013-08-06 12:24:05 -040063 <img src="uml_class_diagram_for_oauth2cl_13.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_13" ismap="ismap" class="graph-without-title" />
Joe Gregorio52a5c532013-01-24 16:19:07 -050064</center>
65</center>
66<hr />
67<pre class="literalblock">
68NDB Model for storage for the sites XSRF secret key.
69
70Since this model uses the same kind as SiteXsrfSecretKey, it can be used
71interchangeably. This simply provides an NDB model for interacting with the
72same data the DB model interacts with.
73
74There should only be one instance stored of this model, the one used for the
75site.
76
77</pre>
78
79<!-- ==================== CLASS METHODS ==================== -->
80<a name="section-ClassMethods"></a>
81<table class="summary" border="1" cellpadding="3"
82 cellspacing="0" width="100%" bgcolor="white">
83<tr bgcolor="#70b0f0" class="table-header">
84 <td colspan="2" class="table-header">
85 <table border="0" cellpadding="0" cellspacing="0" width="100%">
86 <tr valign="top">
87 <td align="left"><span class="table-header">Class Methods</span></td>
88 <td align="right" valign="top"
89 ><span class="options">[<a href="#section-ClassMethods"
90 class="privatelink" onclick="toggle_private();"
91 >hide private</a>]</span></td>
92 </tr>
93 </table>
94 </td>
95</tr>
96<tr class="private">
97 <td width="15%" align="right" valign="top" class="summary">
98 <span class="summary-type">&nbsp;</span>
99 </td><td class="summary">
100 <table width="100%" cellpadding="0" cellspacing="0" border="0">
101 <tr>
102 <td><span class="summary-sig"><a name="_get_kind"></a><span class="summary-sig-name">_get_kind</span>(<span class="summary-sig-arg">cls</span>)</span><br />
103 Return the kind name for this class.</td>
104 <td align="right" valign="top">
105 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#SiteXsrfSecretKeyNDB._get_kind">source&nbsp;code</a></span>
106
107 </td>
108 </tr>
109 </table>
110
111 </td>
112 </tr>
113</table>
114<!-- ==================== CLASS VARIABLES ==================== -->
115<a name="section-ClassVariables"></a>
116<table class="summary" 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">Class Variables</span></td>
123 <td align="right" valign="top"
124 ><span class="options">[<a href="#section-ClassVariables"
125 class="privatelink" onclick="toggle_private();"
126 >hide private</a>]</span></td>
127 </tr>
128 </table>
129 </td>
130</tr>
131<tr>
132 <td width="15%" align="right" valign="top" class="summary">
133 <span class="summary-type">&nbsp;</span>
134 </td><td class="summary">
135 <a name="secret"></a><span class="summary-name">secret</span> = <code title="ndb.StringProperty()">ndb.StringProperty()</code>
136 </td>
137 </tr>
138</table>
139<!-- ==================== NAVIGATION BAR ==================== -->
140<table class="navbar" border="0" width="100%" cellpadding="0"
141 bgcolor="#a0c0ff" cellspacing="0">
142 <tr valign="middle">
143
144 <!-- Tree link -->
145 <th>&nbsp;&nbsp;&nbsp;<a
146 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
147
148 <!-- Index link -->
149 <th>&nbsp;&nbsp;&nbsp;<a
150 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
151
152 <!-- Help link -->
153 <th>&nbsp;&nbsp;&nbsp;<a
154 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
155
156 <th class="navbar" width="100%"></th>
157 </tr>
158</table>
159<table border="0" cellpadding="0" cellspacing="0" width="100%%">
160 <tr>
161 <td align="left" class="footer">
Joe Gregorio37802c32013-08-06 12:24:05 -0400162 Generated by Epydoc 3.0.1 on Tue Aug 6 12:16:45 2013
Joe Gregorio52a5c532013-01-24 16:19:07 -0500163 </td>
164 <td align="right" class="footer">
165 <a target="mainFrame" href="http://epydoc.sourceforge.net"
166 >http://epydoc.sourceforge.net</a>
167 </td>
168 </tr>
169</table>
170
171<script type="text/javascript">
172 <!--
173 // Private objects are initially displayed (because if
174 // javascript is turned off then we want them to be
175 // visible); but by default, we want to hide them. So hide
176 // them unless we have a cookie that says to show them.
177 checkCookie();
178 // -->
179</script>
180</body>
181</html>