Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5dc0f5c893f00427fe5ea7940dd5f3055ee0b726 / . / docs / epy / oauth2client.appengine.CredentialsProperty-class.html
blob: 82d9b66af32a6d87051ad4fc4817adb676495791 [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.CredentialsProperty</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;CredentialsProperty
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.CredentialsProperty-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 CredentialsProperty</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsProperty">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="uml_class_diagram_for_oauth2cl_3" name="uml_class_diagram_for_oauth2cl_3">
59<area shape="rect" href="oauth2client.client.Credentials-class.html" title="Base class for all Credentials objects." alt="" coords="249,247,519,265"/>
60<area shape="rect" href="oauth2client.appengine.CredentialsProperty-class.html#get_value_for_datastore" title="Datastore representation of this property." alt="" coords="249,268,519,287"/>
61<area shape="rect" href="oauth2client.appengine.CredentialsProperty-class.html#make_value_from_datastore" title="Native representation of this property." alt="" coords="249,287,519,305"/>
62<area shape="rect" href="oauth2client.appengine.CredentialsProperty-class.html#validate" title="Assert that provided value is compatible with this property." alt="" coords="249,305,519,324"/>
63<area shape="rect" href="oauth2client.appengine.CredentialsProperty-class.html" title="App Engine datastore Property for Credentials." alt="" coords="248,229,520,325"/>
64<area shape="rect" href="javascript:void(0);" title="google.appengine.ext.db.Property.creation_counter" alt="" coords="17,28,751,47"/>
65<area shape="rect" href="javascript:void(0);" title="Initializes this Property with the given options." alt="" coords="17,49,751,68"/>
66<area shape="rect" href="javascript:void(0);" title="Configure property, connecting it to its model." alt="" coords="17,68,751,87"/>
67<area shape="rect" href="javascript:void(0);" title="Returns the value for this property on the given model instance." alt="" coords="17,87,751,105"/>
68<area shape="rect" href="javascript:void(0);" title="Sets the value for this property on the given model instance." alt="" coords="17,105,751,124"/>
69<area shape="rect" href="javascript:void(0);" title="Default value for unassigned values." alt="" coords="17,124,751,143"/>
70<area shape="rect" href="javascript:void(0);" title="Determine if value is empty in the context of this property." alt="" coords="17,143,751,161"/>
71<area shape="rect" href="javascript:void(0);" title="Determine new value for auto&#45;updated property." alt="" coords="17,161,751,180"/>
72<area shape="rect" href="javascript:void(0);" title="Deprecated backwards&#45;compatible accessor method for self.data_type." alt="" coords="17,180,751,199"/>
73<area shape="rect" href="javascript:void(0);" title="A Property is an attribute of a Model." alt="" coords="16,11,752,200"/>
74</map>
75 <img src="uml_class_diagram_for_oauth2cl_3.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_3" ismap="ismap" class="graph-without-title" />
76</center>
77</center>
78<hr />
79<pre class="literalblock">
80App Engine datastore Property for Credentials.
81
82Utility property that allows easy storage and retrieval of
83oath2client.Credentials
84
85</pre>
86
87<!-- ==================== NESTED CLASSES ==================== -->
88<a name="section-NestedClasses"></a>
89<table class="summary" border="1" cellpadding="3"
90 cellspacing="0" width="100%" bgcolor="white">
91<tr bgcolor="#70b0f0" class="table-header">
92 <td colspan="2" class="table-header">
93 <table border="0" cellpadding="0" cellspacing="0" width="100%">
94 <tr valign="top">
95 <td align="left"><span class="table-header">Nested Classes</span></td>
96 <td align="right" valign="top"
97 ><span class="options">[<a href="#section-NestedClasses"
98 class="privatelink" onclick="toggle_private();"
99 >hide private</a>]</span></td>
100 </tr>
101 </table>
102 </td>
103</tr>
104<tr>
105 <td width="15%" align="right" valign="top" class="summary">
106 <span class="summary-type">&nbsp;</span>
107 </td><td class="summary">
108 <a href="oauth2client.client.Credentials-class.html" class="summary-name">data_type</a><br />
109 Base class for all Credentials objects.
110 </td>
111 </tr>
112</table>
113<!-- ==================== INSTANCE METHODS ==================== -->
114<a name="section-InstanceMethods"></a>
115<table class="summary" border="1" cellpadding="3"
116 cellspacing="0" width="100%" bgcolor="white">
117<tr bgcolor="#70b0f0" class="table-header">
118 <td colspan="2" class="table-header">
119 <table border="0" cellpadding="0" cellspacing="0" width="100%">
120 <tr valign="top">
121 <td align="left"><span class="table-header">Instance Methods</span></td>
122 <td align="right" valign="top"
123 ><span class="options">[<a href="#section-InstanceMethods"
124 class="privatelink" onclick="toggle_private();"
125 >hide private</a>]</span></td>
126 </tr>
127 </table>
128 </td>
129</tr>
130<tr>
131 <td width="15%" align="right" valign="top" class="summary">
132 <span class="summary-type">&nbsp;</span>
133 </td><td class="summary">
134 <table width="100%" cellpadding="0" cellspacing="0" border="0">
135 <tr>
136 <td><span class="summary-sig"><a href="oauth2client.appengine.CredentialsProperty-class.html#get_value_for_datastore" class="summary-sig-name">get_value_for_datastore</a>(<span class="summary-sig-arg">self</span>,
137 <span class="summary-sig-arg">model_instance</span>)</span><br />
138 Datastore representation of this property.</td>
139 <td align="right" valign="top">
140 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsProperty.get_value_for_datastore">source&nbsp;code</a></span>
141
142 </td>
143 </tr>
144 </table>
145
146 </td>
147 </tr>
148<tr>
149 <td width="15%" align="right" valign="top" class="summary">
150 <span class="summary-type">&nbsp;</span>
151 </td><td class="summary">
152 <table width="100%" cellpadding="0" cellspacing="0" border="0">
153 <tr>
154 <td><span class="summary-sig"><a href="oauth2client.appengine.CredentialsProperty-class.html#make_value_from_datastore" class="summary-sig-name">make_value_from_datastore</a>(<span class="summary-sig-arg">self</span>,
155 <span class="summary-sig-arg">value</span>)</span><br />
156 Native representation of this property.</td>
157 <td align="right" valign="top">
158 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsProperty.make_value_from_datastore">source&nbsp;code</a></span>
159
160 </td>
161 </tr>
162 </table>
163
164 </td>
165 </tr>
166<tr>
167 <td width="15%" align="right" valign="top" class="summary">
168 <span class="summary-type">&nbsp;</span>
169 </td><td class="summary">
170 <table width="100%" cellpadding="0" cellspacing="0" border="0">
171 <tr>
172 <td><span class="summary-sig"><a href="oauth2client.appengine.CredentialsProperty-class.html#validate" class="summary-sig-name">validate</a>(<span class="summary-sig-arg">self</span>,
173 <span class="summary-sig-arg">value</span>)</span><br />
174 Assert that provided value is compatible with this property.</td>
175 <td align="right" valign="top">
176 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsProperty.validate">source&nbsp;code</a></span>
177
178 </td>
179 </tr>
180 </table>
181
182 </td>
183 </tr>
184 <tr>
185 <td colspan="2" class="summary">
186 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Property</code></b>:
187 <code>__get__</code>,
188 <code>__init__</code>,
189 <code>__property_config__</code>,
190 <code>__set__</code>,
191 <code>datastore_type</code>,
192 <code>default_value</code>,
193 <code>empty</code>,
194 <code>get_updated_value_for_datastore</code>
195 </p>
196 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Property</code></b> (private):
197 <code>_attr_name</code>,
198 <code>_require_parameter</code>
199 </p></div>
200 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
201 <code>__delattr__</code>,
202 <code>__format__</code>,
203 <code>__getattribute__</code>,
204 <code>__hash__</code>,
205 <code>__new__</code>,
206 <code>__reduce__</code>,
207 <code>__reduce_ex__</code>,
208 <code>__repr__</code>,
209 <code>__setattr__</code>,
210 <code>__sizeof__</code>,
211 <code>__str__</code>,
212 <code>__subclasshook__</code>
213 </p>
214 </td>
215 </tr>
216</table>
217<!-- ==================== CLASS VARIABLES ==================== -->
218<a name="section-ClassVariables"></a>
219<table class="summary" border="1" cellpadding="3"
220 cellspacing="0" width="100%" bgcolor="white">
221<tr bgcolor="#70b0f0" class="table-header">
222 <td colspan="2" class="table-header">
223 <table border="0" cellpadding="0" cellspacing="0" width="100%">
224 <tr valign="top">
225 <td align="left"><span class="table-header">Class Variables</span></td>
226 <td align="right" valign="top"
227 ><span class="options">[<a href="#section-ClassVariables"
228 class="privatelink" onclick="toggle_private();"
229 >hide private</a>]</span></td>
230 </tr>
231 </table>
232 </td>
233</tr>
234 <tr>
235 <td colspan="2" class="summary">
236 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Property</code></b>:
237 <code>creation_counter</code>
238 </p>
239 </td>
240 </tr>
241</table>
242<!-- ==================== PROPERTIES ==================== -->
243<a name="section-Properties"></a>
244<table class="summary" border="1" cellpadding="3"
245 cellspacing="0" width="100%" bgcolor="white">
246<tr bgcolor="#70b0f0" class="table-header">
247 <td colspan="2" class="table-header">
248 <table border="0" cellpadding="0" cellspacing="0" width="100%">
249 <tr valign="top">
250 <td align="left"><span class="table-header">Properties</span></td>
251 <td align="right" valign="top"
252 ><span class="options">[<a href="#section-Properties"
253 class="privatelink" onclick="toggle_private();"
254 >hide private</a>]</span></td>
255 </tr>
256 </table>
257 </td>
258</tr>
259 <tr>
260 <td colspan="2" class="summary">
261 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
262 <code>__class__</code>
263 </p>
264 </td>
265 </tr>
266</table>
267<!-- ==================== METHOD DETAILS ==================== -->
268<a name="section-MethodDetails"></a>
269<table class="details" border="1" cellpadding="3"
270 cellspacing="0" width="100%" bgcolor="white">
271<tr bgcolor="#70b0f0" class="table-header">
272 <td colspan="2" class="table-header">
273 <table border="0" cellpadding="0" cellspacing="0" width="100%">
274 <tr valign="top">
275 <td align="left"><span class="table-header">Method Details</span></td>
276 <td align="right" valign="top"
277 ><span class="options">[<a href="#section-MethodDetails"
278 class="privatelink" onclick="toggle_private();"
279 >hide private</a>]</span></td>
280 </tr>
281 </table>
282 </td>
283</tr>
284</table>
285<a name="get_value_for_datastore"></a>
286<div>
287<table class="details" border="1" cellpadding="3"
288 cellspacing="0" width="100%" bgcolor="white">
289<tr><td>
290 <table width="100%" cellpadding="0" cellspacing="0" border="0">
291 <tr valign="top"><td>
292 <h3 class="epydoc"><span class="sig"><span class="sig-name">get_value_for_datastore</span>(<span class="sig-arg">self</span>,
293 <span class="sig-arg">model_instance</span>)</span>
294 </h3>
295 </td><td align="right" valign="top"
296 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsProperty.get_value_for_datastore">source&nbsp;code</a></span>&nbsp;
297 </td>
298 </tr></table>
299
300 <pre class="literalblock">
301Datastore representation of this property.
302
303Looks for this property in the given model instance, and returns the proper
304datastore representation of the value that can be stored in a datastore
305entity. Most critically, it will fetch the datastore key value for
306reference properties.
307
308Some properies (e.g. DateTimeProperty, UserProperty) optionally update their
309value on every put(). This call must return the current value for such
310properties (get_updated_value_for_datastore returns the new value).
311
312Args:
313 model_instance: Instance to fetch datastore value from.
314
315Returns:
316 Datastore representation of the model value in a form that is
317 appropriate for storing in the datastore.
318
319</pre>
320 <dl class="fields">
321 <dt>Overrides:
322 google.appengine.ext.db.Property.get_value_for_datastore
323 <dd><em class="note">(inherited documentation)</em></dd>
324 </dt>
325 </dl>
326</td></tr></table>
327</div>
328<a name="make_value_from_datastore"></a>
329<div>
330<table class="details" border="1" cellpadding="3"
331 cellspacing="0" width="100%" bgcolor="white">
332<tr><td>
333 <table width="100%" cellpadding="0" cellspacing="0" border="0">
334 <tr valign="top"><td>
335 <h3 class="epydoc"><span class="sig"><span class="sig-name">make_value_from_datastore</span>(<span class="sig-arg">self</span>,
336 <span class="sig-arg">value</span>)</span>
337 </h3>
338 </td><td align="right" valign="top"
339 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsProperty.make_value_from_datastore">source&nbsp;code</a></span>&nbsp;
340 </td>
341 </tr></table>
342
343 <pre class="literalblock">
344Native representation of this property.
345
346Given a value retrieved from a datastore entity, return a value,
347possibly converted, to be stored on the model instance. Usually
348this returns the value unchanged, but a property class may
349override this when it uses a different datatype on the model
350instance than on the entity.
351
352This API is not quite symmetric with get_value_for_datastore(),
353because the model instance on which to store the converted value
354may not exist yet -- we may be collecting values to be passed to a
355model constructor.
356
357Args:
358 value: value retrieved from the datastore entity.
359
360Returns:
361 The value converted for use as a model instance attribute.
362
363</pre>
364 <dl class="fields">
365 <dt>Overrides:
366 google.appengine.ext.db.Property.make_value_from_datastore
367 <dd><em class="note">(inherited documentation)</em></dd>
368 </dt>
369 </dl>
370</td></tr></table>
371</div>
372<a name="validate"></a>
373<div>
374<table class="details" border="1" cellpadding="3"
375 cellspacing="0" width="100%" bgcolor="white">
376<tr><td>
377 <table width="100%" cellpadding="0" cellspacing="0" border="0">
378 <tr valign="top"><td>
379 <h3 class="epydoc"><span class="sig"><span class="sig-name">validate</span>(<span class="sig-arg">self</span>,
380 <span class="sig-arg">value</span>)</span>
381 </h3>
382 </td><td align="right" valign="top"
383 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsProperty.validate">source&nbsp;code</a></span>&nbsp;
384 </td>
385 </tr></table>
386
387 <pre class="literalblock">
388Assert that provided value is compatible with this property.
389
390Args:
391 value: Value to validate against this Property.
392
393Returns:
394 A valid value, either the input unchanged or adapted to the
395 required type.
396
397Raises:
398 BadValueError if the value is not appropriate for this
399 property in any way.
400
401</pre>
402 <dl class="fields">
403 <dt>Overrides:
404 google.appengine.ext.db.Property.validate
405 <dd><em class="note">(inherited documentation)</em></dd>
406 </dt>
407 </dl>
408</td></tr></table>
409</div>
410<br />
411<!-- ==================== NAVIGATION BAR ==================== -->
412<table class="navbar" border="0" width="100%" cellpadding="0"
413 bgcolor="#a0c0ff" cellspacing="0">
414 <tr valign="middle">
415
416 <!-- Tree link -->
417 <th>&nbsp;&nbsp;&nbsp;<a
418 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
419
420 <!-- Index link -->
421 <th>&nbsp;&nbsp;&nbsp;<a
422 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
423
424 <!-- Help link -->
425 <th>&nbsp;&nbsp;&nbsp;<a
426 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
427
428 <th class="navbar" width="100%"></th>
429 </tr>
430</table>
431<table border="0" cellpadding="0" cellspacing="0" width="100%%">
432 <tr>
433 <td align="left" class="footer">
434 Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:08 2012
435 </td>
436 <td align="right" class="footer">
437 <a target="mainFrame" href="http://epydoc.sourceforge.net"
438 >http://epydoc.sourceforge.net</a>
439 </td>
440 </tr>
441</table>
442
443<script type="text/javascript">
444 <!--
445 // Private objects are initially displayed (because if
446 // javascript is turned off then we want them to be
447 // visible); but by default, we want to hide them. So hide
448 // them unless we have a cookie that says to show them.
449 checkCookie();
450 // -->
451</script>
452</body>
453</html>