Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5dc0f5c893f00427fe5ea7940dd5f3055ee0b726 / . / docs / epy / oauth2client.appengine.CredentialsModel-class.html
blob: 63cfd29e4acfcaf61fb4fb9c520ab3f8c03bd574 [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame^]1<?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>
58<center> <map id="uml_class_diagram_for_oauth2cl_2" name="uml_class_diagram_for_oauth2cl_2">
59<area shape="rect" href="oauth2client.appengine.CredentialsModel-class.html#credentials" title="oauth2client.appengine.CredentialsModel.credentials" alt="" coords="221,377,323,396"/>
60<area shape="rect" href="oauth2client.appengine.CredentialsModel-class.html" title="Storage for OAuth 2.0 Credentials" alt="" coords="220,360,324,405"/>
61<area shape="rect" href="google.appengine.ext.db.PropertiedClass-class.html" title="Meta&#45;class for initializing Model classes properties." alt="" coords="17,28,527,47"/>
62<area shape="rect" href="javascript:void(0);" title="Allow subclasses to call __new__() with arguments." alt="" coords="17,49,527,68"/>
63<area shape="rect" href="javascript:void(0);" title="Creates a new instance of this model." alt="" coords="17,68,527,87"/>
64<area shape="rect" href="javascript:void(0);" title="Unique key for this entity." alt="" coords="17,87,527,105"/>
65<area shape="rect" href="javascript:void(0);" title="Writes this model instance to the datastore." alt="" coords="17,105,527,124"/>
66<area shape="rect" href="javascript:void(0);" title="Writes this model instance to the datastore." alt="" coords="17,124,527,143"/>
67<area shape="rect" href="javascript:void(0);" title="Deletes this entity from the datastore." alt="" coords="17,143,527,161"/>
68<area shape="rect" href="javascript:void(0);" title="Determine if entity is persisted in the datastore." alt="" coords="17,161,527,180"/>
69<area shape="rect" href="javascript:void(0);" title="Determine if this model instance has a complete key." alt="" coords="17,180,527,199"/>
70<area shape="rect" href="javascript:void(0);" title="Returns a list of all dynamic properties defined for instance." alt="" coords="17,199,527,217"/>
71<area shape="rect" href="javascript:void(0);" title="Alias for dyanmic_properties." alt="" coords="17,217,527,236"/>
72<area shape="rect" href="javascript:void(0);" title="Get the parent of the model instance." alt="" coords="17,236,527,255"/>
73<area shape="rect" href="javascript:void(0);" title="Get the parent&#39;s key." alt="" coords="17,255,527,273"/>
74<area shape="rect" href="javascript:void(0);" title="Generate an XML representation of this model instance." alt="" coords="17,273,527,292"/>
75<area shape="rect" href="javascript:void(0);" title="Soon to be removed alias for properties." alt="" coords="17,311,527,329"/>
76<area shape="rect" href="javascript:void(0);" title="Model is the superclass of all object entities in the datastore." alt="" coords="16,11,528,331"/>
77</map>
78 <img src="uml_class_diagram_for_oauth2cl_2.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_2" ismap="ismap" class="graph-without-title" />
79</center>
80</center>
81<hr />
82<pre class="literalblock">
83Storage for OAuth 2.0 Credentials
84
85Storage of the model is keyed by the user.user_id().
86
87</pre>
88
89<!-- ==================== NESTED CLASSES ==================== -->
90<a name="section-NestedClasses"></a>
91<table class="summary" border="1" cellpadding="3"
92 cellspacing="0" width="100%" bgcolor="white">
93<tr bgcolor="#70b0f0" class="table-header">
94 <td colspan="2" class="table-header">
95 <table border="0" cellpadding="0" cellspacing="0" width="100%">
96 <tr valign="top">
97 <td align="left"><span class="table-header">Nested Classes</span></td>
98 <td align="right" valign="top"
99 ><span class="options">[<a href="#section-NestedClasses"
100 class="privatelink" onclick="toggle_private();"
101 >hide private</a>]</span></td>
102 </tr>
103 </table>
104 </td>
105</tr>
106 <tr>
107 <td colspan="2" class="summary">
108 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b>:
109 <code><a href="google.appengine.ext.db.PropertiedClass-class.html">__metaclass__</a></code>
110 </p>
111 </td>
112 </tr>
113</table>
114<!-- ==================== INSTANCE METHODS ==================== -->
115<a name="section-InstanceMethods"></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">Instance Methods</span></td>
123 <td align="right" valign="top"
124 ><span class="options">[<a href="#section-InstanceMethods"
125 class="privatelink" onclick="toggle_private();"
126 >hide private</a>]</span></td>
127 </tr>
128 </table>
129 </td>
130</tr>
131 <tr>
132 <td colspan="2" class="summary">
133 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b>:
134 <code>__init__</code>,
135 <code>delete</code>,
136 <code>dynamic_properties</code>,
137 <code>has_key</code>,
138 <code>instance_properties</code>,
139 <code>is_saved</code>,
140 <code>key</code>,
141 <code>parent</code>,
142 <code>parent_key</code>,
143 <code>put</code>,
144 <code>save</code>,
145 <code>to_xml</code>
146 </p>
147 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b> (private):
148 <code>_populate_entity</code>,
149 <code>_populate_internal_entity</code>,
150 <code>_to_entity</code>
151 </p></div>
152 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
153 <code>__delattr__</code>,
154 <code>__format__</code>,
155 <code>__getattribute__</code>,
156 <code>__hash__</code>,
157 <code>__reduce__</code>,
158 <code>__reduce_ex__</code>,
159 <code>__repr__</code>,
160 <code>__setattr__</code>,
161 <code>__sizeof__</code>,
162 <code>__str__</code>,
163 <code>__subclasshook__</code>
164 </p>
165 </td>
166 </tr>
167</table>
168<!-- ==================== CLASS METHODS ==================== -->
169<a name="section-ClassMethods"></a>
170<table class="summary" border="1" cellpadding="3"
171 cellspacing="0" width="100%" bgcolor="white">
172<tr bgcolor="#70b0f0" class="table-header">
173 <td colspan="2" class="table-header">
174 <table border="0" cellpadding="0" cellspacing="0" width="100%">
175 <tr valign="top">
176 <td align="left"><span class="table-header">Class Methods</span></td>
177 <td align="right" valign="top"
178 ><span class="options">[<a href="#section-ClassMethods"
179 class="privatelink" onclick="toggle_private();"
180 >hide private</a>]</span></td>
181 </tr>
182 </table>
183 </td>
184</tr>
185 <tr>
186 <td colspan="2" class="summary">
187 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b>:
188 <code>all</code>,
189 <code>entity_type</code>,
190 <code>fields</code>,
191 <code>from_entity</code>,
192 <code>get</code>,
193 <code>get_by_id</code>,
194 <code>get_by_key_name</code>,
195 <code>get_or_insert</code>,
196 <code>gql</code>,
197 <code>kind</code>,
198 <code>properties</code>
199 </p>
200 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b> (private):
201 <code>_load_entity_values</code>
202 </p></div>
203 </td>
204 </tr>
205</table>
206<!-- ==================== STATIC METHODS ==================== -->
207<a name="section-StaticMethods"></a>
208<table class="summary" border="1" cellpadding="3"
209 cellspacing="0" width="100%" bgcolor="white">
210<tr bgcolor="#70b0f0" class="table-header">
211 <td colspan="2" class="table-header">
212 <table border="0" cellpadding="0" cellspacing="0" width="100%">
213 <tr valign="top">
214 <td align="left"><span class="table-header">Static Methods</span></td>
215 <td align="right" valign="top"
216 ><span class="options">[<a href="#section-StaticMethods"
217 class="privatelink" onclick="toggle_private();"
218 >hide private</a>]</span></td>
219 </tr>
220 </table>
221 </td>
222</tr>
223 <tr>
224 <td colspan="2" class="summary">
225 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b>:
226 <code>__new__</code>
227 </p>
228 </td>
229 </tr>
230</table>
231<!-- ==================== CLASS VARIABLES ==================== -->
232<a name="section-ClassVariables"></a>
233<table class="summary" border="1" cellpadding="3"
234 cellspacing="0" width="100%" bgcolor="white">
235<tr bgcolor="#70b0f0" class="table-header">
236 <td colspan="2" class="table-header">
237 <table border="0" cellpadding="0" cellspacing="0" width="100%">
238 <tr valign="top">
239 <td align="left"><span class="table-header">Class Variables</span></td>
240 <td align="right" valign="top"
241 ><span class="options">[<a href="#section-ClassVariables"
242 class="privatelink" onclick="toggle_private();"
243 >hide private</a>]</span></td>
244 </tr>
245 </table>
246 </td>
247</tr>
248<tr>
249 <td width="15%" align="right" valign="top" class="summary">
250 <span class="summary-type">&nbsp;</span>
251 </td><td class="summary">
252 <a name="credentials"></a><span class="summary-name">credentials</span> = <code title="CredentialsProperty()">CredentialsProperty()</code>
253 </td>
254 </tr>
255<tr class="private">
256 <td width="15%" align="right" valign="top" class="summary">
257 <span class="summary-type">&nbsp;</span>
258 </td><td class="summary">
259 <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>
260 </td>
261 </tr>
262<tr class="private">
263 <td width="15%" align="right" valign="top" class="summary">
264 <span class="summary-type">&nbsp;</span>
265 </td><td class="summary">
266 <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 \
2670x2532210&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>
268 </td>
269 </tr>
270 <tr>
271 <td colspan="2" class="summary">
272 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b> (private):
273 <code>_unindexed_properties</code>
274 </p></div>
275 </td>
276 </tr>
277</table>
278<!-- ==================== PROPERTIES ==================== -->
279<a name="section-Properties"></a>
280<table class="summary" border="1" cellpadding="3"
281 cellspacing="0" width="100%" bgcolor="white">
282<tr bgcolor="#70b0f0" class="table-header">
283 <td colspan="2" class="table-header">
284 <table border="0" cellpadding="0" cellspacing="0" width="100%">
285 <tr valign="top">
286 <td align="left"><span class="table-header">Properties</span></td>
287 <td align="right" valign="top"
288 ><span class="options">[<a href="#section-Properties"
289 class="privatelink" onclick="toggle_private();"
290 >hide private</a>]</span></td>
291 </tr>
292 </table>
293 </td>
294</tr>
295 <tr>
296 <td colspan="2" class="summary">
297 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
298 <code>__class__</code>
299 </p>
300 </td>
301 </tr>
302</table>
303<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
304<a name="section-ClassVariableDetails"></a>
305<table class="details" border="1" cellpadding="3"
306 cellspacing="0" width="100%" bgcolor="white">
307<tr bgcolor="#70b0f0" class="table-header">
308 <td colspan="2" class="table-header">
309 <table border="0" cellpadding="0" cellspacing="0" width="100%">
310 <tr valign="top">
311 <td align="left"><span class="table-header">Class Variable Details</span></td>
312 <td align="right" valign="top"
313 ><span class="options">[<a href="#section-ClassVariableDetails"
314 class="privatelink" onclick="toggle_private();"
315 >hide private</a>]</span></td>
316 </tr>
317 </table>
318 </td>
319</tr>
320</table>
321<a name="_properties"></a>
322<div class="private">
323<table class="details" border="1" cellpadding="3"
324 cellspacing="0" width="100%" bgcolor="white">
325<tr><td>
326 <h3 class="epydoc">_properties</h3>
327
328 <dl class="fields">
329 </dl>
330 <dl class="fields">
331 <dt>Value:</dt>
332 <dd><table><tr><td><pre class="variable">
333<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>
3340x2532210&gt;<code class="variable-group">}</code>
335</pre></td></tr></table>
336</dd>
337 </dl>
338</td></tr></table>
339</div>
340<br />
341<!-- ==================== NAVIGATION BAR ==================== -->
342<table class="navbar" border="0" width="100%" cellpadding="0"
343 bgcolor="#a0c0ff" cellspacing="0">
344 <tr valign="middle">
345
346 <!-- Tree link -->
347 <th>&nbsp;&nbsp;&nbsp;<a
348 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
349
350 <!-- Index link -->
351 <th>&nbsp;&nbsp;&nbsp;<a
352 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
353
354 <!-- Help link -->
355 <th>&nbsp;&nbsp;&nbsp;<a
356 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
357
358 <th class="navbar" width="100%"></th>
359 </tr>
360</table>
361<table border="0" cellpadding="0" cellspacing="0" width="100%%">
362 <tr>
363 <td align="left" class="footer">
364 Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:08 2012
365 </td>
366 <td align="right" class="footer">
367 <a target="mainFrame" href="http://epydoc.sourceforge.net"
368 >http://epydoc.sourceforge.net</a>
369 </td>
370 </tr>
371</table>
372
373<script type="text/javascript">
374 <!--
375 // Private objects are initially displayed (because if
376 // javascript is turned off then we want them to be
377 // visible); but by default, we want to hide them. So hide
378 // them unless we have a cookie that says to show them.
379 checkCookie();
380 // -->
381</script>
382</body>
383</html>