blob: 7bb4473dfd204adebd646f3d22f465944da5b9e8 [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"/>
Joe Gregoriof4839b02012-09-06 13:47:24 -040060<area shape="rect" href="oauth2client.appengine.CredentialsModel-class.html" title="CredentialsModel" alt="" coords="229,5,349,32"/>
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>,
Joe Gregoriof4839b02012-09-06 13:47:24 -0400119 <code>__new__</code>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400120 <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>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400191<!-- ==================== CLASS VARIABLES ==================== -->
192<a name="section-ClassVariables"></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">Class Variables</span></td>
200 <td align="right" valign="top"
201 ><span class="options">[<a href="#section-ClassVariables"
202 class="privatelink" onclick="toggle_private();"
203 >hide private</a>]</span></td>
204 </tr>
205 </table>
206 </td>
207</tr>
208<tr>
209 <td width="15%" align="right" valign="top" class="summary">
210 <span class="summary-type">&nbsp;</span>
211 </td><td class="summary">
212 <a name="credentials"></a><span class="summary-name">credentials</span> = <code title="CredentialsProperty()">CredentialsProperty()</code>
213 </td>
214 </tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400215</table>
216<!-- ==================== PROPERTIES ==================== -->
217<a name="section-Properties"></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">Properties</span></td>
225 <td align="right" valign="top"
226 ><span class="options">[<a href="#section-Properties"
227 class="privatelink" onclick="toggle_private();"
228 >hide private</a>]</span></td>
229 </tr>
230 </table>
231 </td>
232</tr>
233 <tr>
234 <td colspan="2" class="summary">
235 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
236 <code>__class__</code>
237 </p>
238 </td>
239 </tr>
240</table>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400241<!-- ==================== NAVIGATION BAR ==================== -->
242<table class="navbar" border="0" width="100%" cellpadding="0"
243 bgcolor="#a0c0ff" cellspacing="0">
244 <tr valign="middle">
245
246 <!-- Tree link -->
247 <th>&nbsp;&nbsp;&nbsp;<a
248 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
249
250 <!-- Index link -->
251 <th>&nbsp;&nbsp;&nbsp;<a
252 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
253
254 <!-- Help link -->
255 <th>&nbsp;&nbsp;&nbsp;<a
256 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
257
258 <th class="navbar" width="100%"></th>
259 </tr>
260</table>
261<table border="0" cellpadding="0" cellspacing="0" width="100%%">
262 <tr>
263 <td align="left" class="footer">
Joe Gregoriod67010d2012-11-05 08:57:06 -0500264 Generated by Epydoc 3.0.1 on Mon Nov 5 08:53:54 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400265 </td>
266 <td align="right" class="footer">
267 <a target="mainFrame" href="http://epydoc.sourceforge.net"
268 >http://epydoc.sourceforge.net</a>
269 </td>
270 </tr>
271</table>
272
273<script type="text/javascript">
274 <!--
275 // Private objects are initially displayed (because if
276 // javascript is turned off then we want them to be
277 // visible); but by default, we want to hide them. So hide
278 // them unless we have a cookie that says to show them.
279 checkCookie();
280 // -->
281</script>
282</body>
283</html>