Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3aaca548a7bea3c67d49c28f2b13b4cf9a21633b / . / docs / epy / oauth2client.appengine.CredentialsModel-class.html
blob: 8ea09fc9ea3a40cad49947abbb5d4443e0f2b0bd [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>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]58<center> <map id="uml_class_diagram_for_oauth2cl_2" name="uml_class_diagram_for_oauth2cl_2">
59<area shape="rect" id="node105" href="oauth2client.appengine.CredentialsModel-class.html#credentials" title="oauth2client.appengine.CredentialsModel.credentials" alt="" coords="224,383,327,401"/>
60<area shape="rect" id="node1" href="oauth2client.appengine.CredentialsModel-class.html" title="Storage for OAuth 2.0 Credentials" alt="" coords="212,358,337,415"/>
61<area shape="rect" id="node106" 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="node106" href="javascript:void(0);" title="Allow subclasses to call __new__() with arguments." alt="" coords="17,52,533,71"/>
63<area shape="rect" id="node106" href="javascript:void(0);" title="Creates a new instance of this model." alt="" coords="17,71,533,89"/>
64<area shape="rect" id="node106" href="javascript:void(0);" title="Unique key for this entity." alt="" coords="17,89,533,108"/>
65<area shape="rect" id="node106" href="javascript:void(0);" title="Writes this model instance to the datastore." alt="" coords="17,108,533,127"/>
66<area shape="rect" id="node106" href="javascript:void(0);" title="Writes this model instance to the datastore." alt="" coords="17,127,533,145"/>
67<area shape="rect" id="node106" href="javascript:void(0);" title="Deletes this entity from the datastore." alt="" coords="17,145,533,164"/>
68<area shape="rect" id="node106" href="javascript:void(0);" title="Determine if entity is persisted in the datastore." alt="" coords="17,164,533,183"/>
69<area shape="rect" id="node106" 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="node106" 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="node106" href="javascript:void(0);" title="Alias for dyanmic_properties." alt="" coords="17,220,533,239"/>
72<area shape="rect" id="node106" href="javascript:void(0);" title="Get the parent of the model instance." alt="" coords="17,239,533,257"/>
73<area shape="rect" id="node106" href="javascript:void(0);" title="Get the parent&#39;s key." alt="" coords="17,257,533,276"/>
74<area shape="rect" id="node106" href="javascript:void(0);" title="Generate an XML representation of this model instance." alt="" coords="17,276,533,295"/>
75<area shape="rect" id="node106" 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 Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]77</map>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]78 <img src="uml_class_diagram_for_oauth2cl_2.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_2" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]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
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]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>__new__</code>,
136 <code>delete</code>,
137 <code>dynamic_properties</code>,
138 <code>has_key</code>,
139 <code>instance_properties</code>,
140 <code>is_saved</code>,
141 <code>key</code>,
142 <code>parent</code>,
143 <code>parent_key</code>,
144 <code>put</code>,
145 <code>save</code>,
146 <code>to_xml</code>
147 </p>
148 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b> (private):
149 <code>_populate_entity</code>,
150 <code>_populate_internal_entity</code>,
151 <code>_to_entity</code>
152 </p></div>
153 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
154 <code>__delattr__</code>,
155 <code>__format__</code>,
156 <code>__getattribute__</code>,
157 <code>__hash__</code>,
158 <code>__reduce__</code>,
159 <code>__reduce_ex__</code>,
160 <code>__repr__</code>,
161 <code>__setattr__</code>,
162 <code>__sizeof__</code>,
163 <code>__str__</code>,
164 <code>__subclasshook__</code>
165 </p>
166 </td>
167 </tr>
168</table>
169<!-- ==================== CLASS METHODS ==================== -->
170<a name="section-ClassMethods"></a>
171<table class="summary" border="1" cellpadding="3"
172 cellspacing="0" width="100%" bgcolor="white">
173<tr bgcolor="#70b0f0" class="table-header">
174 <td colspan="2" class="table-header">
175 <table border="0" cellpadding="0" cellspacing="0" width="100%">
176 <tr valign="top">
177 <td align="left"><span class="table-header">Class Methods</span></td>
178 <td align="right" valign="top"
179 ><span class="options">[<a href="#section-ClassMethods"
180 class="privatelink" onclick="toggle_private();"
181 >hide private</a>]</span></td>
182 </tr>
183 </table>
184 </td>
185</tr>
186 <tr>
187 <td colspan="2" class="summary">
188 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b>:
189 <code>all</code>,
190 <code>entity_type</code>,
191 <code>fields</code>,
192 <code>from_entity</code>,
193 <code>get</code>,
194 <code>get_by_id</code>,
195 <code>get_by_key_name</code>,
196 <code>get_or_insert</code>,
197 <code>gql</code>,
198 <code>kind</code>,
199 <code>properties</code>
200 </p>
201 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Model</code></b> (private):
202 <code>_load_entity_values</code>
203 </p></div>
204 </td>
205 </tr>
206</table>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]207<!-- ==================== CLASS VARIABLES ==================== -->
208<a name="section-ClassVariables"></a>
209<table class="summary" border="1" cellpadding="3"
210 cellspacing="0" width="100%" bgcolor="white">
211<tr bgcolor="#70b0f0" class="table-header">
212 <td colspan="2" class="table-header">
213 <table border="0" cellpadding="0" cellspacing="0" width="100%">
214 <tr valign="top">
215 <td align="left"><span class="table-header">Class Variables</span></td>
216 <td align="right" valign="top"
217 ><span class="options">[<a href="#section-ClassVariables"
218 class="privatelink" onclick="toggle_private();"
219 >hide private</a>]</span></td>
220 </tr>
221 </table>
222 </td>
223</tr>
224<tr>
225 <td width="15%" align="right" valign="top" class="summary">
226 <span class="summary-type">&nbsp;</span>
227 </td><td class="summary">
228 <a name="credentials"></a><span class="summary-name">credentials</span> = <code title="CredentialsProperty()">CredentialsProperty()</code>
229 </td>
230 </tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]231</table>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]232<!-- ==================== PROPERTIES ==================== -->
233<a name="section-Properties"></a>
234<table class="summary" border="1" cellpadding="3"
235 cellspacing="0" width="100%" bgcolor="white">
236<tr bgcolor="#70b0f0" class="table-header">
237 <td colspan="2" class="table-header">
238 <table border="0" cellpadding="0" cellspacing="0" width="100%">
239 <tr valign="top">
240 <td align="left"><span class="table-header">Properties</span></td>
241 <td align="right" valign="top"
242 ><span class="options">[<a href="#section-Properties"
243 class="privatelink" onclick="toggle_private();"
244 >hide private</a>]</span></td>
245 </tr>
246 </table>
247 </td>
248</tr>
249 <tr>
250 <td colspan="2" class="summary">
251 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
252 <code>__class__</code>
253 </p>
254 </td>
255 </tr>
256</table>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]257<!-- ==================== NAVIGATION BAR ==================== -->
258<table class="navbar" border="0" width="100%" cellpadding="0"
259 bgcolor="#a0c0ff" cellspacing="0">
260 <tr valign="middle">
261
262 <!-- Tree link -->
263 <th>&nbsp;&nbsp;&nbsp;<a
264 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
265
266 <!-- Index link -->
267 <th>&nbsp;&nbsp;&nbsp;<a
268 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
269
270 <!-- Help link -->
271 <th>&nbsp;&nbsp;&nbsp;<a
272 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
273
274 <th class="navbar" width="100%"></th>
275 </tr>
276</table>
277<table border="0" cellpadding="0" cellspacing="0" width="100%%">
278 <tr>
279 <td align="left" class="footer">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]280 Generated by Epydoc 3.0.1 on Tue Aug 6 12:16:44 2013
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]281 </td>
282 <td align="right" class="footer">
283 <a target="mainFrame" href="http://epydoc.sourceforge.net"
284 >http://epydoc.sourceforge.net</a>
285 </td>
286 </tr>
287</table>
288
289<script type="text/javascript">
290 <!--
291 // Private objects are initially displayed (because if
292 // javascript is turned off then we want them to be
293 // visible); but by default, we want to hide them. So hide
294 // them unless we have a cookie that says to show them.
295 checkCookie();
296 // -->
297</script>
298</body>
299</html>