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